We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 5db557e commit 27afe80Copy full SHA for 27afe80
1 file changed
README.rst
@@ -35,6 +35,12 @@ Todd Wolfson's ``restructuredtext-lint`` code:
35
- http://docutils.sourceforge.net/
36
- https://github.com/twolfson/restructuredtext-lint
37
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
+
44
You may *also* wish to install the related flake8 plugin `flake8-rst
45
<https://github.com/kataev/flake8-rst>`_ which can check the Python style
46
of doctest formatted snippets of Python code within your ``*.rst`` files
0 commit comments