Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Commit 5e96487

Browse files
peterjcmrshannon
andauthored
Update conventions documentation for v4.0.0 (#393)
* Update conventions documentation for v4.0.0 Addresses the problem I noted in a comment on issue #380 * Link to PR updating docs * Add google convention to documentation. * Move news entry to current dev version Co-authored-by: Michael R. Shannon <[email protected]>
1 parent 832fd11 commit 5e96487

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

docs/error_codes.rst

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,23 @@ Grouping
99
Default conventions
1010
-------------------
1111

12-
Not all error codes are checked for by default. There are three
13-
conventions that may be used by pydocstyle: ``pep257``, ``numpy`` and ``google``.
14-
15-
The pep257 convention, which is enabled by default in pydocstyle,
16-
checks for all of the above errors except for D203, D212, D213, D214,
17-
D215, D404, D405, D406, D407, D408, D409, D410, D411, D413, D415, D416 and D417
18-
(as specified in `PEP257 <http://www.python.org/dev/peps/pep-0257/>`_).
19-
20-
The numpy convention checks for all of the above errors except for
21-
D107, D203, D212, D213, D402, D413, D415, D416 and D417.
22-
23-
The google convention checks for all of the above errors except for
24-
D203, D204, D213, D215, D400, D401, D404, D406, D407, D408, D409 and D413.
12+
Not all error codes are checked for by default. There are three conventions
13+
that may be used by pydocstyle: ``pep257``, ``numpy`` and ``google``.
14+
15+
The ``pep257`` convention (specified in `PEP257
16+
<http://www.python.org/dev/peps/pep-0257/>`_), which is enabled by default in
17+
pydocstyle, checks for all of the above errors except for D203, D212, D213,
18+
D214, D215, D404, D405, D406, D407, D408, D409, D410, D411, D413, D415, D416
19+
and D417.
20+
21+
The ``numpy`` convention added in v2.0.0 supports the `numpydoc docstring
22+
<https://github.com/numpy/numpydoc>`_ standard. This checks all of of the
23+
errors except for D107, D203, D212, D213, D402, D413, D415, D416, and D417.
24+
25+
The ``google`` convention added in v4.0.0 supports the `Google Python Style
26+
Guide <https://google.github.io/styleguide/pyguide.html>`_. This checks for
27+
all the errors except D203, D204, D213, D215, D400, D401, D404, D406, D407,
28+
D408, D409 and D413.
2529

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

docs/release_notes.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ New Features
1111

1212
* Skip function arguments prefixed with `_` in D417 check (#440).
1313

14+
Bug Fixes
15+
16+
* Update convention support documentation (#386, #393)
1417

1518
5.0.2 - January 8th, 2020
1619
---------------------------

0 commit comments

Comments
 (0)