Skip to content

Commit afde36c

Browse files
authored
Update conventions documentation for v4.0.0
Addresses the problem I noted in a comment on issue PyCQA#380
1 parent 49183a3 commit afde36c

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/error_codes.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,21 @@ Grouping
99
Default conventions
1010
-------------------
1111

12-
Not all error codes are checked for by default. There are two
13-
conventions that may be used by pydocstyle: pep257 and numpy.
12+
Not all error codes are checked for by default.
1413

15-
The pep257 convention, which is enabled by default in pydocstyle,
14+
The ``pep257`` convention, which is enabled by default in pydocstyle,
1615
checks for all of the above errors except for D203, D212, D213, D214,
1716
D215, D404, D405, D406, D407, D408, D409, D410, and D411 (as specified
1817
in `PEP257 <http://www.python.org/dev/peps/pep-0257/>`_).
1918

20-
The numpy convention checks for all of the above errors except for
21-
D107, D203, D212, D213, D402, and D413.
19+
The ``numpy`` convention added in v2.0.0 supports the `numpydoc docstring
20+
<https://github.com/numpy/numpydoc>`_ standard. This checks all of of the
21+
errors except for D107, D203, D212, D213, D402, D413, D415, D416, and D417.
22+
23+
The ``google`` convention added in v4.0.0 supports the `Google Python Style
24+
Guide <https://google.github.io/styleguide/pyguide.html>`_. This checks for
25+
all the errors except D203, D204, D213, D215, D400, D401, D404, D406, D407,
26+
D408, D409.
2227

2328
These conventions may be specified using `--convention=<name>` when
2429
running pydocstyle from the command line or by specifying the

0 commit comments

Comments
 (0)