pydocstyle supports most of PEP 257 <http://www.python.org/dev/peps/pep-0257/>_ out of the box, but it should not be considered a reference implementation.

pydocstyle supports Python 3.6+.

Quick Start

Install ^^^^^^^

.. code::

pip install pydocstyle

Run ^^^

.. code::

$ 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 environment in the cloud right from your browser -

.. image:: https://gitpod.io/button/open-in-gitpod.svg :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle :alt: Open in Gitpod

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

Links

Read the full documentation here <https://pydocstyle.org/en/stable/>_.
Fork pydocstyle on GitHub <https://github.com/PyCQA/pydocstyle>_.
PyPI project page <https://pypi.python.org/pypi/pydocstyle>_.

FAQs

What is pydocstyle?

Is pydocstyle well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install