docstring style checker
Clone or download
shacharoo Introducing type hints (#342)
* Initial support for type hinting

* Remove superfluous spaces

* Add types to
Latest commit cb677b6 Oct 20, 2018


pydocstyle - docstring style checker Documentation Status

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


pip install pydocstyle


$ pydocstyle in private nested class `meta`:
        D101: Docstring missing 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)