Extension for flake8 which uses pep257 to check docstrings
Project description
flake8-docstrings
A simple module that adds an extension for the fantastic pep257 tool to flake8.
Simply install this extension:
pip install flake8_docstrings
and run flake8.
Report any issues on our bug tracker.
History/Changelog
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!
Project details
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
File details
Details for the file flake8-docstrings-0.2.7.tar.gz
.
File metadata
- Download URL: flake8-docstrings-0.2.7.tar.gz
- Upload date:
- Size: 4.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9279c55609cf6f30fd916cdb7df1e64633a4fa97dae0a9806cc4f9b0ddcf3f99 |
|
MD5 | f4096064909b2d135cd77e54f985d707 |
|
BLAKE2b-256 | 5516a650e0d725690927a1ab2583495a9bdac0cf962f574eaa588ee789e3d741 |
File details
Details for the file flake8_docstrings-0.2.7-py2.py3-none-any.whl
.
File metadata
- Download URL: flake8_docstrings-0.2.7-py2.py3-none-any.whl
- Upload date:
- Size: 5.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4befc698b63ad758d6cdea39aece2df3c5615baed22f479c7194c0e6e5773b1 |
|
MD5 | e7699032dcf3ad5bff4c36a9379859d2 |
|
BLAKE2b-256 | 169d2a8f7ad1b3b4098600b8d9230dfb5ee478c0750630b8927d0a3cfc414778 |