Skip to content
master
Switch branches/tags
Code

Latest commit

* Add support for Python 3.10

* Python 3.10 requires pytest 6.2+

* Don't use unmaintained pytest-pep8, doesn't support pytest 6.2 needed for Python 3.10

* Drop the dot https://twitter.com/pytestdotorg/status/753767547866972160

* Add support for Python 3.10
0a78a1d

Git stats

Files

Permalink
Failed to load latest commit information.

pydocstyle - docstring style checker

Documentation Status https://pepy.tech/badge/pydocstyle https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 Gitpod ready-to-code

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

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

Develop

You can use Gitpod to run pre-configured dev envrionment in the cloud right from your browser -

Open in Gitpod

Before submitting a PR make sure that you run make all.

Links