Skip to content

bagelbits/pep257

 
 

Repository files navigation

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

image

Documentation Status

About

PEP 257 docstring style checker.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%