Skip to content
docstring style checker
Python
Find file

README.rst

pydocstyle - docstring style checker

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

The framework for checking docstring style is flexible, and custom checks can be easily added, for example to cover NumPy docstring conventions.

pydocstyle supports Python 2.6, 2.7, 3.3, 3.4, 3.5, pypy and pypy3.

Quick Start

Install

pip install pydocstyle

Run

$ pydocstyle test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:22 in public method `method`:
        D102: Docstring missing
...

Links

https://travis-ci.org/PyCQA/pydocstyle.svg?branch=master Documentation Status
Something went wrong with that request. Please try again.