pydocstyle’s documentation

(formerly pep257)

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.

Quick Start

  1. Install

    pip install pydocstyle
  2. Run

    $ pydocstyle in private nested class `meta`:
            D101: Docstring missing in public method `method`:
            D102: Docstring missing
  3. Fix your code :)



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

Maintained by Amir Rachum.