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)
...
Links
Project details
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
pydocstyle-6.1.1.tar.gz
(35.7 kB
view hashes)
Built Distribution
pydocstyle-6.1.1-py3-none-any.whl
(37.2 kB
view hashes)
Close
Hashes for pydocstyle-6.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6987826d6775056839940041beef5c08cc7e3d71d63149b48e36727f70144dc4 |
|
MD5 | 0f218a198f2f8012ed68036252c4bed3 |
|
BLAKE2b-256 | 87674df10786068766000518c6ad9c4a614e77585a12ab8f0654c776757ac9dc |