A simple flake8 plugin that checks if everything has a docstring
Project description
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.
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 |
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file flake8-docstring-checker-1.2.tar.gz.
File metadata
- Download URL: flake8-docstring-checker-1.2.tar.gz
- Upload date:
- Size: 3.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a77b9d1be479f53e92903663106962e1367e93cdae0ad3e0806f1b2db4a420e5 |
|
| MD5 | 3b62ef78e2c7ca0f3b392990ea720040 |
|
| BLAKE2b-256 | 1c4efb04ff8751baa73199a1927e3987071d8b9238be2472c6a81b4398c023ab |
File details
Details for the file flake8_docstring_checker-1.2-py3-none-any.whl.
File metadata
- Download URL: flake8_docstring_checker-1.2-py3-none-any.whl
- Upload date:
- Size: 3.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ad527dabfa09818c0cb3cea2ae98aedbd90f62fda87f2185ed67850c3a120cb1 |
|
| MD5 | 4b013cd21d092fe4f513f557980d520c |
|
| BLAKE2b-256 | 4720bc67b2dbe2ad285cd7f494a5fef5d402d59a25ca7585ce54f3c93cd70c16 |
