Extension for flake8 which uses pydocstyle to check docstrings

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for asottile from gravatar.com asottile Avatar for graffatcolmingov from gravatar.com graffatcolmingov

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Simon ANDRÉ
  • Maintainer: Ian Cordasco
  • Tags PEP 257, pydocstyle, pep257, docstrings, flake8
  • Requires: Python >=3.7
Classifiers

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.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for asottile from gravatar.com asottile Avatar for graffatcolmingov from gravatar.com graffatcolmingov

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Simon ANDRÉ
  • Maintainer: Ian Cordasco
  • Tags PEP 257, pydocstyle, pep257, docstrings, flake8
  • Requires: Python >=3.7
Classifiers

Release history Release notifications | RSS feed

This version

1.7.0

1.6.0

1.5.0

1.4.0

1.3.1

1.3.0

1.2.0

1.1.0

1.0.3

1.0.2

1.0.1

0.2.8

0.2.7

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1.post1

0.2.1

0.2.0

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.0

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

Uploaded Source

Built Distribution

flake8_docstrings-1.7.0-py2.py3-none-any.whl (5.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file flake8_docstrings-1.7.0.tar.gz.

File metadata

  • Download URL: flake8_docstrings-1.7.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for flake8_docstrings-1.7.0.tar.gz
Algorithm Hash digest
SHA256 4c8cc748dc16e6869728699e5d0d685da9a10b0ea718e090b1ba088e67a941af
MD5 776d8ea9284e828d93f944bcd8286240
BLAKE2b-256 9324f839e3a06e18f4643ccb81370909a497297909f15106e6af2fecdef46894

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flake8_docstrings-1.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 51f2344026da083fc084166a9353f5082b01f72901df422f74b4d953ae88ac75
MD5 4984d55b8984fc3d358c47fa6858824e
BLAKE2b-256 3f7d76a278fa43250441ed9300c344f889c7fb1817080c8fb8996b840bf421c2

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