1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
Error Codes
===========
Grouping
--------
.. include:: snippets/error_code_table.rst
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 (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 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
convention in a configuration file. See the :ref:`cli_usage` section
for more details.
.. note::
It makes no sense to check the same docstring for both ``numpy`` and ``google``
conventions. Therefore, if we successfully detect that a docstring is in the
``numpy`` style, we don't check it for ``google``.
The reason ``numpy`` style takes precedence over ``google`` is that the
heuristics of detecting it are better, and we don't want to enforce users to
provide external hints to `pydocstyle` in order to let it know which style
docstrings are written in.
Publicity
---------
.. include:: snippets/publicity.rst
|
