From 5e964875aef99b9df6f238616228ef1286afcfac Mon Sep 17 00:00:00 2001
From: Peter Cock
Date: Sat, 7 Mar 2020 16:04:19 +0000
Subject: [PATCH] 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
---
docs/error_codes.rst | 30 +++++++++++++++++-------------
docs/release_notes.rst | 3 +++
2 files changed, 20 insertions(+), 13 deletions(-)
diff --git a/docs/error_codes.rst b/docs/error_codes.rst
index 59b7a0f1..0808ed39 100644
--- a/docs/error_codes.rst
+++ b/docs/error_codes.rst
@@ -9,19 +9,23 @@ Grouping
Default conventions
-------------------
-Not all error codes are checked for by default. There are three
-conventions that may be used by pydocstyle: ``pep257``, ``numpy`` and ``google``.
-
-The pep257 convention, which is enabled by default in pydocstyle,
-checks for all of the above errors except for D203, D212, D213, D214,
-D215, D404, D405, D406, D407, D408, D409, D410, D411, D413, D415, D416 and D417
-(as specified in `PEP257 `_).
-
-The numpy convention checks for all of the above errors except for
-D107, D203, D212, D213, D402, D413, D415, D416 and D417.
-
-The google convention checks for all of the above errors except for
-D203, D204, D213, D215, D400, D401, D404, D406, D407, D408, D409 and D413.
+Not all error codes are checked for by default. There are three conventions
+that may be used by pydocstyle: ``pep257``, ``numpy`` and ``google``.
+
+The ``pep257`` convention (specified in `PEP257
+`_), which is enabled by default in
+pydocstyle, checks for all of the above errors except for D203, D212, D213,
+D214, D215, D404, D405, D406, D407, D408, D409, D410, D411, D413, D415, D416
+and D417.
+
+The ``numpy`` convention added in v2.0.0 supports the `numpydoc docstring
+`_ standard. This checks all of of the
+errors except for D107, D203, D212, D213, D402, D413, D415, D416, and D417.
+
+The ``google`` convention added in v4.0.0 supports the `Google Python Style
+Guide `_. This checks for
+all the errors except D203, D204, D213, D215, D400, D401, D404, D406, D407,
+D408, D409 and D413.
These conventions may be specified using `--convention=` when
running pydocstyle from the command line or by specifying the
diff --git a/docs/release_notes.rst b/docs/release_notes.rst
index a53b678b..cb3a3278 100644
--- a/docs/release_notes.rst
+++ b/docs/release_notes.rst
@@ -11,6 +11,9 @@ New Features
* Skip function arguments prefixed with `_` in D417 check (#440).
+Bug Fixes
+
+* Update convention support documentation (#386, #393)
5.0.2 - January 8th, 2020
---------------------------