
Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
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
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
Security News
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.