@@ -9,16 +9,21 @@ Grouping
9
9
Default conventions
10
10
-------------------
11
11
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.
14
13
15
- The pep257 convention, which is enabled by default in pydocstyle,
14
+ The `` pep257 `` convention, which is enabled by default in pydocstyle,
16
15
checks for all of the above errors except for D203, D212, D213, D214,
17
16
D215, D404, D405, D406, D407, D408, D409, D410, and D411 (as specified
18
17
in `PEP257 <http://www.python.org/dev/peps/pep-0257/ >`_).
19
18
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.
22
27
23
28
These conventions may be specified using `--convention=<name> ` when
24
29
running pydocstyle from the command line or by specifying the
0 commit comments