Skip to main content

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.

Report any issues on our bug tracker.

History/Changelog

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!

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-1.2.0.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flake8_docstrings-1.2.0-py2.py3-none-any.whl (5.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for flake8-docstrings-1.2.0.tar.gz
Algorithm Hash digest
SHA256 4ee2426690ff67184aec0fad05ea48b36dadd2f03cec3e37c29e4dc1cd272b10
MD5 6d58569196cfdee0f6b3754be2682a4f
BLAKE2b-256 1371bd78e5f77f725eea0412a3e12171b4b741e9a6b0346213cf9959ddff2ce4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flake8_docstrings-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2a4e5b6ad55771fd33725f917e177a968b93719d12948089d43e7b561a5fd2bb
MD5 38479683cdab2489d4fc33c9ee3863f1
BLAKE2b-256 8dbe91992c317dcab51706418636e13387bb21a610f5b62dfe6bc54d59bc72b3

See more details on using hashes here.

Supported by

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