From afde36cd4cbee6457efa4d463edda820fb5ab7a4 Mon Sep 17 00:00:00 2001 From: Peter Cock Date: Mon, 5 Aug 2019 13:54:17 +0100 Subject: [PATCH 1/4] Update conventions documentation for v4.0.0 Addresses the problem I noted in a comment on issue #380 --- docs/error_codes.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/error_codes.rst b/docs/error_codes.rst index 76dd5a04..b701f048 100644 --- a/docs/error_codes.rst +++ b/docs/error_codes.rst @@ -9,16 +9,21 @@ Grouping Default conventions ------------------- -Not all error codes are checked for by default. There are two -conventions that may be used by pydocstyle: pep257 and numpy. +Not all error codes are checked for by default. -The pep257 convention, which is enabled by default in pydocstyle, +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, and D411 (as specified in `PEP257 `_). -The numpy convention checks for all of the above errors except for -D107, D203, D212, D213, D402, and D413. +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. These conventions may be specified using `--convention=` when running pydocstyle from the command line or by specifying the From 955551ad64e5f7e13aadc725f5f5fe28d7983366 Mon Sep 17 00:00:00 2001 From: Peter Cock Date: Mon, 5 Aug 2019 13:58:24 +0100 Subject: [PATCH 2/4] Link to PR updating docs --- docs/release_notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 12b36663..e049af20 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -9,6 +9,7 @@ Current Development Version Bug Fixes +* Update convention support documentation (#393) * D401: Fixed a false positive where one stem had multiple imperative forms, e.g., init and initialize / initiate (#382). * Fix parser hanging when there's a comment directly after ``__all__`` From b936cabe1174e25ef83e1184b60815edd97ae35c Mon Sep 17 00:00:00 2001 From: "Michael R. Shannon" Date: Mon, 29 Jul 2019 08:43:15 -0600 Subject: [PATCH 3/4] Add google convention to documentation. --- docs/release_notes.rst | 2 +- docs/snippets/cli.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release_notes.rst b/docs/release_notes.rst index e049af20..91915d07 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -9,7 +9,7 @@ Current Development Version Bug Fixes -* Update convention support documentation (#393) +* Update convention support documentation (#386, #393) * D401: Fixed a false positive where one stem had multiple imperative forms, e.g., init and initialize / initiate (#382). * Fix parser hanging when there's a comment directly after ``__all__`` diff --git a/docs/snippets/cli.rst b/docs/snippets/cli.rst index 5c97155a..f8b43117 100644 --- a/docs/snippets/cli.rst +++ b/docs/snippets/cli.rst @@ -54,7 +54,7 @@ Usage --convention= choose the basic list of checked errors by specifying an existing convention. Possible conventions: pep257, - numpy. + numpy, google. --add-select= add extra error codes to check to the basic list of errors previously set by --select, --ignore or From b4e10d11aa5110b2945f5c9ac1bb8985c72611cb Mon Sep 17 00:00:00 2001 From: Peter Cock Date: Sat, 7 Mar 2020 14:14:55 +0000 Subject: [PATCH 4/4] Move news entry to current dev version --- docs/release_notes.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 22a4852b..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 --------------------------- @@ -66,7 +69,6 @@ Bug Fixes Bug Fixes -* Update convention support documentation (#386, #393) * D401: Fixed a false positive where one stem had multiple imperative forms, e.g., init and initialize / initiate (#382). * Fix parser hanging when there's a comment directly after ``__all__``