Extension for flake8 which uses pydocstyle to check docstrings
Project description
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.
History/Changelog
1.6.0
Fix --ignore-noqa by disabling pydocstyle’s noqa handling.
1.5.0
Add --ignore-decorators option which allows functions with a specific decorator to ignore error codes.
1.4.0
Add --docstring-convention option which allows selection of conventions besides the default pep257. Available options are based on those available from pydocstyle and are currently pep257, google, and numpy. flake8-docstrings also adds a special all docstring convention which will enable all rules from pydocstyle. Note that pydocstyle defines some conflicting rules so you’ll want to use ignore / extend-ignore when selecting docstring-convention = all
Bump minimum flake8 version to 3
Fix proper handling of stdin via --stdin-display-name
1.3.1
Fix incompatibility with pydocstyle 4.x
1.3.0
Bump minimum pydocstyle version to 2.1.0
1.2.0
Fix EnvironError and AllError invocations
Avoid Flake8 warning for requesting builtins
1.1.0
Upgrade dependency on pydocstyle to 2.0.0
1.0.3
Use flake8-polyfill to get standard-in to handle Flake8 3.x and 2.x
1.0.2
Use pycodestyle to get standard-in.
1.0.1
Make sure this works out of the box (is enabled by default) with Flake8 3.0
1.0.0
Switch dependency name to pydocstyle. pep257 was renamed to pydocstyle, this update switches the requirement to that new package name. Since we’re swapping out dependencies, we’ve issued a major version bump.
0.2.7
Try to import pydocstyle (not pycodestyle) as pep257
0.2.6
Respect pep257’s default ignore list
Handle AllError and other exceptions from pep257
0.2.5
Use pep257’s tokenize_open function to pass input to the tool.
Use pep257’s conventions so any error codes that are ignored by default using pep257 are also ignored by default with this plugin.
0.2.4
Fix bug introduced in 0.2.2 where the file source was always None causing D100 and D104 errors for all files and no other errors to be found.
0.2.3
Remove extraneous space in error message.
Fix up how the plugin displays with flake8 --version.
0.2.2
Better support for input provided via stdin.
0.2.1
Prevent AllError or EnvironmentErrors from being raised. Thanks Alex Pyrgiotis.
0.2.0
Upgrade to pep257 0.3.0
0.1.4
Stop truncating error messages
0.1.3
Really fix the installation issue this time.
0.1.2
Actually fix the PyPI release. Ugh
0.1.1
Fix the PyPI release.
0.1.0
Initial Release!
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.6.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 99cac583d6c7e32dd28bbfbef120a7c0d1b6dde4adb5a9fd441c4227a6534bde |
|
| MD5 | e718d1b592cb22d41c8dee2a8fafcf78 |
|
| BLAKE2b-256 | 8bad35dc9b3585ddbab617679b97487450f873e582408843c07fe97f524463c2 |
