| Name | flake8-docstring-checker JSON |
| Version |
1.2
JSON |
| download |
| home_page | |
| Summary | A simple flake8 plugin that checks if everything has a docstring |
| upload_time | 2023-01-23 11:12:13 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | BSD-2-Clause |
| keywords |
jakobdev
docstrings
flake8
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# flake8-docstring-checker
A simple flake8 plugin that checks if everything has a docstring. This plugin does not more than that. If you want a plugin which more functions you should take a look at [flake8-docstrings](https://pypi.org/project/flake8-docstrings/).
### List of warnings:
| ID | Description |
| ------ | ------ |
| DC100 | Module has no docstring |
| DC101 | Missing docstring in class |
| DC102 | Missing docstring in public function |
| DC103 | Missing docstring in private function |
| DC104 | Missing docstring in special function |
Raw data
{
"_id": null,
"home_page": "",
"name": "flake8-docstring-checker",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "JakobDev,Docstrings,flake8",
"author": "",
"author_email": "JakobDev <jakobdev@gmx.de>",
"download_url": "https://files.pythonhosted.org/packages/1c/4e/fb04ff8751baa73199a1927e3987071d8b9238be2472c6a81b4398c023ab/flake8-docstring-checker-1.2.tar.gz",
"platform": null,
"description": "# flake8-docstring-checker\n\nA simple flake8 plugin that checks if everything has a docstring. This plugin does not more than that. If you want a plugin which more functions you should take a look at [flake8-docstrings](https://pypi.org/project/flake8-docstrings/).\n\n### List of warnings:\n\n| ID | Description |\n| ------ | ------ |\n| DC100 | Module has no docstring |\n| DC101 | Missing docstring in class |\n| DC102 | Missing docstring in public function |\n| DC103 | Missing docstring in private function |\n| DC104 | Missing docstring in special function |\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "A simple flake8 plugin that checks if everything has a docstring",
"version": "1.2",
"split_keywords": [
"jakobdev",
"docstrings",
"flake8"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4720bc67b2dbe2ad285cd7f494a5fef5d402d59a25ca7585ce54f3c93cd70c16",
"md5": "4b013cd21d092fe4f513f557980d520c",
"sha256": "ad527dabfa09818c0cb3cea2ae98aedbd90f62fda87f2185ed67850c3a120cb1"
},
"downloads": -1,
"filename": "flake8_docstring_checker-1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b013cd21d092fe4f513f557980d520c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3726,
"upload_time": "2023-01-23T11:12:11",
"upload_time_iso_8601": "2023-01-23T11:12:11.408553Z",
"url": "https://files.pythonhosted.org/packages/47/20/bc67b2dbe2ad285cd7f494a5fef5d402d59a25ca7585ce54f3c93cd70c16/flake8_docstring_checker-1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c4efb04ff8751baa73199a1927e3987071d8b9238be2472c6a81b4398c023ab",
"md5": "3b62ef78e2c7ca0f3b392990ea720040",
"sha256": "a77b9d1be479f53e92903663106962e1367e93cdae0ad3e0806f1b2db4a420e5"
},
"downloads": -1,
"filename": "flake8-docstring-checker-1.2.tar.gz",
"has_sig": false,
"md5_digest": "3b62ef78e2c7ca0f3b392990ea720040",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3241,
"upload_time": "2023-01-23T11:12:13",
"upload_time_iso_8601": "2023-01-23T11:12:13.497418Z",
"url": "https://files.pythonhosted.org/packages/1c/4e/fb04ff8751baa73199a1927e3987071d8b9238be2472c6a81b4398c023ab/flake8-docstring-checker-1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-23 11:12:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "flake8-docstring-checker"
}
