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 3.7 through 3.11.

Although pydocstyle is tries to be compatible with Python 3.6, it is not tested.

Quick Start

  1. Install

    pip install pydocstyle

  2. 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)
...

  3. Fix your code :)

Contents:

Credits

pydocstyle is a rename and continuation of pep257, a project created by Vladimir Keleshev.

Maintained by Amir Rachum and Sambhav Kothari.