docstring style checker
Python
Latest commit e416156 Jan 11, 2017 @Nurdok Nurdok committed on GitHub Merge pull request #227 from jdufresne/remove-all-warning
Remove warning when __all__ is a list

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.

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

Quick Start

Install

pip install pydocstyle

Run

$ pydocstyle test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:27 in public function `get_user`:
    D300: Use """triple double quotes""" (found '''-quotes)
test:75 in public function `init_database`:
    D201: No blank lines allowed before function docstring (found 1)
...

Links

https://travis-ci.org/PyCQA/pydocstyle.svg?branch=master Documentation Status