flake8-docstrings

Extension for flake8 which uses pydocstyle to check docstrings

MIT 27 个版本 Python >=3.7

Simon ANDRÉ <sandre@anybox.fr>

安装

pip install flake8-docstrings

poetry add flake8-docstrings

pipenv install flake8-docstrings

conda install flake8-docstrings

描述

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

分类

Environment :: Console Intended Audience :: Developers License :: OSI Approved :: MIT License Operating System :: OS Independent Programming Language :: Python :: 3 Programming Language :: Python :: 3 :: Only Programming Language :: Python :: Implementation :: CPython

版本列表

1.7.0 2023-01-25

1.6.0 2021-03-19

1.5.0 2019-09-30

1.4.0 2019-08-26

1.3.1 2019-08-02

1.3.0 2018-01-04

1.2.0 2018-01-04

1.1.0 2017-04-28

1.0.3 2017-01-24

1.0.2 2016-07-26

1.0.1 2016-07-26

0.2.8 2016-06-17

0.2.7 2016-06-16

0.2.6 2016-05-01

0.2.5 2016-02-17

0.2.4 2015-11-25

0.2.3 2015-11-24

0.2.2 2015-11-24

0.2.1 2014-10-01

0.2.1.post1 2015-01-07

0.2.0 2014-03-07

0.1.4 2014-01-03

0.1.3 2013-10-08

0.1.2 2013-06-16

0.1.1 2013-06-03

0.1.0 2013-05-22

0.0.0