https://github.com/pycqa/flake8-docstrings

Integration of pydocstyle and flake8 for combined linting and reporting
https://github.com/pycqa/flake8-docstrings

docstrings flake8 flake8-extension flake8-plugin pydocstyle

Last synced: about 2 months ago
JSON representation

Integration of pydocstyle and flake8 for combined linting and reporting

• Host: GitHub
• URL: https://github.com/pycqa/flake8-docstrings
• Owner: PyCQA
• License: mit
• Created: 2015-07-10T18:39:48.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-04-29T23:31:09.000Z (2 months ago)
• Last Synced: 2024-05-09T08:41:47.454Z (about 2 months ago)
• Topics: docstrings, flake8, flake8-extension, flake8-plugin, pydocstyle
• Language: Python
• Homepage:
• Size: 140 KB
• Stars: 154
• Watchers: 10
• Forks: 17
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • License: LICENSE

Lists

• awesome-flake8-extensions - flake8-docstrings - Include checks provided by pep257. (Docstrings)

README

        
flake8-docstrings

=================

A simple module that adds an extension for the fantastic pydocstyle_ tool to

flake8_.

Simply install this extension::

    pip install flake8-docstrings

and run flake8.

You can set the pydocstyle convention_ at the command line using::

    $ flake8 --docstring-convention numpy ...

Or, adding ``docstring-convention=numpy`` to your flake8 configuration file.

The available set of conventions depends on the version of pydocstyle installed.

The default is ``pep257``, pydocstyle v2.0.0 added ``numpy`` (for the numpydoc

standard), while pydocstyle v4.0.0 added ``google``.

In order to choose a custom list of error codes, use the special value

``docstring-convention=all``, then choose the codes you want checked using

flake8_'s built-in ``--ignore``/``--select`` functionality.

Report any issues on our `bug tracker`_.

.. _pydocstyle: https://github.com/pycqa/pydocstyle

.. _flake8: https://github.com/pycqa/flake8

.. _convention: http://www.pydocstyle.org/en/latest/error_codes.html#default-conventions

.. _bug tracker: https://github.com/pycqa/flake8-docstrings/issues