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.5, 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-5.0.2.tar.gz
(32.5 kB
view hashes)
Built Distribution
pydocstyle-5.0.2-py3-none-any.whl
(35.1 kB
view hashes)
Close
Hashes for pydocstyle-5.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da7831660b7355307b32778c4a0dbfb137d89254ef31a2b2978f50fc0b4d7586 |
|
MD5 | 574258f3516683e2fc3f1ede154270b4 |
|
BLAKE2b-256 | ccfb0662498401c663606ef35b4ec6a0aca6b4121d6da8c3ac40a4e68f6ac521 |