Skip to main content

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.8

  • Import either pycodestyle or pep8 to use stdin_get_value. This fixes the problem for newer Flake8’s (2.6.0+) and older ones.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8-docstrings-0.2.8.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

flake8_docstrings-0.2.8-py2.py3-none-any.whl (5.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file flake8-docstrings-0.2.8.tar.gz.

File metadata

File hashes

Hashes for flake8-docstrings-0.2.8.tar.gz
Algorithm Hash digest
SHA256 5dba5f987e7c5ab8f41fe74e04a4c892437c5e8fbaec78411a05f964524f37ce
MD5 12f1ab06a903ebdc7aed6320bee9c20c
BLAKE2b-256 6afe5070815446178c144bded247319be7b7261dfb283ef4ecb2054f75c837ec

See more details on using hashes here.

File details

Details for the file flake8_docstrings-0.2.8-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for flake8_docstrings-0.2.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6c64e271a70f39989fa95dbaca808b411b35dea6b8ca86fd1860ecadbeb8d816
MD5 d1ca5babcf355c95d4b73240cf4af9f5
BLAKE2b-256 f354363fd4c54a9f35fadca9112834cf4c1678c5bed0fce74dfdcd98ffd278d3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page