Python docstring style checker
Project description
(formerly pep257)
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 2.7, 3.3, 3.4, 3.5 and pypy.
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-2.0.0.zip
(33.3 kB
view hashes)
Built Distribution
Close
Hashes for pydocstyle-2.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 199fc5d0c03b737f0999613e2784bb5b47ad9ea0211b011ee5ea0afd51aa62e9 |
|
MD5 | fabd0b1aa293481a466eb0366f32bfe7 |
|
BLAKE2b-256 | 5cca0849f5a833575eb43c57dc5a40ca825615b234d161cc69bc9ce5867d7169 |