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_.
.. _pydocstyle: https://github.com/pycqa/pydocstyle .. _flake8: https://github.com/pycqa/flake8 .. _convention: http://www.pydocstyle.org/en/latest/error_codes.html#default-conventions .. _bug tracker: https://github.com/pycqa/flake8-docstrings/issues
FAQs
Extension for flake8 which uses pydocstyle to check docstrings
We found that flake8-docstrings demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.