Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 1.63 KB

README.rst

File metadata and controls

62 lines (39 loc) · 1.63 KB

pydocstyle - docstring style checker

image

image

Documentation Status

image

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 3.5, 3.6, 3.7 and 3.8.

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