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

Commit 0b04362

Browse files
Document new behavior in usage docs.
1 parent 4522aeb commit 0b04362

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/snippets/cli.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,14 @@ Usage
4242
regular expression; default is --ignore-decorators=''
4343
which does not ignore any decorated functions.
4444
45+
.. note::
46+
47+
When using any of the ``--select``, ``--ignore``, ``--add-select``, or
48+
``--add-ignore`` command line flags, it is possible to pass a prefix for an
49+
error code. It will be expanded so that any code begining with that prefix
50+
will match. For example, running the command ``pydocstyle --ignore=D4``
51+
will ignore all docstring content issues as their error codes begining with
52+
"D4" (i.e. D400, D401, D402, D403, and D404).
4553

4654
Return Code
4755
^^^^^^^^^^^

0 commit comments

Comments
 (0)