Python docstring style checker
Project description
pydocstyle is a static analysis tool for checking compliance with Python docstring conventions.
pydocstyle supports most of PEP 257 out of the box, but it should not be considered a reference implementation.
pydocstyle supports Python 3.6, 3.7 and 3.8.
Quick Start
Install
pip install pydocstyle
Run
$ pydocstyle test.py
test.py:18 in private nested class `meta`:
D101: Docstring missing
test.py:27 in public function `get_user`:
D300: Use """triple double quotes""" (found '''-quotes)
test:75 in public function `init_database`:
D201: No blank lines allowed before function docstring (found 1)
...
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.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size pydocstyle-6.0.0-py3-none-any.whl (36.0 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
| Filename, size pydocstyle-6.0.0.tar.gz (34.3 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for pydocstyle-6.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d4449cf16d7e6709f63192146706933c7a334af7c0f083904799ccb851c50f6d |
|
| MD5 | 91f54eb306a2803a64af4793d65c2c28 |
|
| BLAKE2-256 | c5f02211d04ef3054c09b2b193e5f377db945e5cfd1fc401eb44a78023df5c24 |
