skip to navigation
skip to content

pydocstyle 2.1.1

Python 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, 3.6 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)
...
 
File Type Py Version Uploaded on Size
pydocstyle-2.1.1-py2-none-any.whl (md5) Python Wheel 2.7 2017-10-09 31KB
pydocstyle-2.1.1-py3-none-any.whl (md5) Python Wheel 3.6 2017-10-09 31KB
pydocstyle-2.1.1.tar.gz (md5) Source 2017-10-09 27KB