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

Commit 1043525

Browse files
Document usage of prefixes in the help output.
1 parent aa37c7f commit 1043525

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

docs/snippets/cli.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,12 @@ Usage
1717
--count print total number of errors to stdout
1818
--select=<codes> choose the basic list of checked errors by specifying
1919
which errors to check for (with a list of comma-
20-
separated error codes). for example:
21-
--select=D101,D202
20+
separated error codes or prefixes). for example:
21+
--select=D101,D2
2222
--ignore=<codes> choose the basic list of checked errors by specifying
2323
which errors to ignore (with a list of comma-separated
24-
error codes). for example: --ignore=D101,D202
24+
error codes or prefixes). for example:
25+
--ignore=D101,D2
2526
--convention=<name> choose the basic list of checked errors by specifying
2627
an existing convention. Possible conventions: pep257
2728
--add-select=<codes> amend the list of errors to check for by specifying

src/pydocstyle/config.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -514,13 +514,13 @@ def _create_option_parser(cls):
514514
option('--select', metavar='<codes>', default=None,
515515
help='choose the basic list of checked errors by '
516516
'specifying which errors to check for (with a list of '
517-
'comma-separated error codes). '
518-
'for example: --select=D101,D202')
517+
'comma-separated error codes or prefixes). '
518+
'for example: --select=D101,D2')
519519
option('--ignore', metavar='<codes>', default=None,
520520
help='choose the basic list of checked errors by '
521521
'specifying which errors to ignore (with a list of '
522-
'comma-separated error codes). '
523-
'for example: --ignore=D101,D202')
522+
'comma-separated error codes or prefixes). '
523+
'for example: --ignore=D101,D2')
524524
option('--convention', metavar='<name>', default=None,
525525
help='choose the basic list of checked errors by specifying an '
526526
'existing convention. Possible conventions: {}'

0 commit comments

Comments
 (0)