Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Latest commit

 

History

History
35 lines (21 loc) · 643 Bytes

index.rst

File metadata and controls

35 lines (21 loc) · 643 Bytes

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 2.7, 3.3, 3.4, 3.5 and pypy.

Contents:

.. toctree::
   :maxdepth: 2

   usage
   error_codes
   release_notes
   license


Credits

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

Maintained by Amir Rachum.