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.


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

Maintained by Amir Rachum and Sambhav Kothari.