Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
PEP 257 docstring style checker.
Python
branch: master

README.rst

PEP 257 docstring style checker

pep257 is a static analysis tool for checking compliance with Python PEP 257.

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

pep257 supports Python 2.6, 2.7, 3.2, 3.3, 3.4, pypy and pypy3.

Quick Start

Install

pip install pep257

Run

$ pep257 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/GreenSteam/pep257.svg?branch=master Documentation Status
Something went wrong with that request. Please try again.