pydocstyle’s documentation¶
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.
Attention
Support for Python 2.7 will be removed in the next release.
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) ...
Fix your code :)
Contents:
Credits¶
pydocstyle is a rename and continuation of pep257, a project created by Vladimir Keleshev.
Maintained by Amir Rachum.