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

Update conventions documentation for v4.0.0 #393

Merged
merged 5 commits into from Mar 7, 2020
Merged

Update conventions documentation for v4.0.0 #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
afde36c
Update conventions documentation for v4.0.0
peterjc Aug 5, 2019
955551a
Link to PR updating docs
peterjc Aug 5, 2019
b936cab
Add google convention to documentation.
mrshannon Jul 29, 2019
0052791
Merge branch 'master' into patch-1
peterjc Mar 6, 2020
b4e10d1
Move news entry to current dev version
peterjc Mar 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 17 additions & 13 deletions docs/error_codes.rst
View file
Open in desktop
Expand Up @@ -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 <http://www.python.org/dev/peps/pep-0257/>`_).

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
<http://www.python.org/dev/peps/pep-0257/>`_), 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
<https://github.com/numpy/numpydoc>`_ 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 <https://google.github.io/styleguide/pyguide.html>`_. 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=<name>` when
running pydocstyle from the command line or by specifying the
Expand Down
3 changes: 3 additions & 0 deletions docs/release_notes.rst
View file
Open in desktop
Expand Up @@ -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
---------------------------
Expand Down