Extension for flake8 which uses pydocstyle to check docstrings
Project description
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flake8_docstrings-1.7.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 51f2344026da083fc084166a9353f5082b01f72901df422f74b4d953ae88ac75 |
|
| MD5 | 4984d55b8984fc3d358c47fa6858824e |
|
| BLAKE2b-256 | 3f7d76a278fa43250441ed9300c344f889c7fb1817080c8fb8996b840bf421c2 |
