Python docstring style checker

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Amir.Rachum from gravatar.com Amir.Rachum Avatar for sambhav_kothari from gravatar.com sambhav_kothari

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Amir Rachum
  • Tags pydocstyle, PEP 257, pep257, PEP 8, pep8, docstrings
Classifiers
Report project as malware

Project description

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page