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.4, 3.5, 3.6 and 3.7.
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-4.0.1.tar.gz
(31.4 kB
view hashes)
Built Distribution
pydocstyle-4.0.1-py3-none-any.whl
(33.9 kB
view hashes)
Close
Hashes for pydocstyle-4.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66aff87ffe34b1e49bff2dd03a88ce6843be2f3346b0c9814410d34987fbab59 |
|
MD5 | 0f2d1497fa74231a275d1af286a4326b |
|
BLAKE2b-256 | 4b175a4834af38d2afd796ec33b809a570966a8173dacabc44cbc30e75001b4f |