pydocstyle - docstring style checker

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.6+.

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

Develop

You can use Gitpod to run pre-configured dev envrionment in the cloud right from your browser -

Before submitting a PR make sure that you run make all.

Links

• Read the full documentation here.
• Fork pydocstyle on GitHub.
• PyPI project page.