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.4, 3.5, 3.6, 3.7, 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-3.0.0.tar.gz
(29.6 kB
view hashes)
Built Distributions
pydocstyle-3.0.0-py3-none-any.whl
(33.0 kB
view hashes)
pydocstyle-3.0.0-py2-none-any.whl
(32.2 kB
view hashes)
Close
Hashes for pydocstyle-3.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed79d4ec5e92655eccc21eb0c6cf512e69512b4a97d215ace46d17e4990f2039 |
|
MD5 | 4ae78f653b00af0e0408701ed2ac7e3d |
|
BLAKE2b-256 | 6e3f9207e1af3fb23c71a2a17a5d82d4c68f4dd6b3429b58514c74b95f6e0784 |
Close
Hashes for pydocstyle-3.0.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2258f9b0df68b97bf3a6c29003edc5238ff8879f1efb6f1999988d934e432bd8 |
|
MD5 | be16626913e15ab6ee84dbe4a625dd18 |
|
BLAKE2b-256 | 89a084d912e2c14f07a65a9207145d69a8bf2e54ea1e81f727042a94febb386c |