Skip to content

Commit 27afe80

Browse files
authored
Recommend flake8-docstrings (pydocstyle PEP257)
1 parent 5db557e commit 27afe80

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ Todd Wolfson's ``restructuredtext-lint`` code:
3535
- http://docutils.sourceforge.net/
3636
- https://github.com/twolfson/restructuredtext-lint
3737

38+
I recommend you *also* install the related `flake8-docstrings
39+
<https://gitlab.com/pycqa/flake8-docstrings>`_ plugin, which brings
40+
the `pydocstyle <https://github.com/pycqa/pydocstyle>`_ checks into flake8.
41+
This checks things like missing docstrings, and other recommendations from
42+
`PEP 257 Docstring Conventions <https://www.python.org/dev/peps/pep-0257/>`_.
43+
3844
You may *also* wish to install the related flake8 plugin `flake8-rst
3945
<https://github.com/kataev/flake8-rst>`_ which can check the Python style
4046
of doctest formatted snippets of Python code within your ``*.rst`` files

0 commit comments

Comments
 (0)