docstring style checker
Python
Clone or download
michael-k and Nurdok Add support for python 3.7 (#324)
* Add support for python 3.7

* Import Set from collections.abc instead of collections

Importing abstract base classes from collections is deprecated since
Python 3.7, see https://bugs.python.org/issue25988.
Latest commit 7f5303c Jul 15, 2018

README.rst

pydocstyle - docstring style checker

https://travis-ci.org/PyCQA/pydocstyle.svg?branch=master https://ci.appveyor.com/api/projects/status/40kkc366bmrrttca/branch/master?svg=true Documentation Status

(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.4, 3.5, 3.6, 3.7, 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