Skip to content

Commit 4372122

Browse files
committed
Update override examples in docs.
1 parent ff8db01 commit 4372122

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

doc/validation.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ the pre-commit hook as follows:
3333
* ``exclude``: Don't report any issues on anything matching the regular
3434
regular expressions ``\.undocumented_method$`` or ``\.__repr__$``.
3535
* ``override_SS05``: Allow docstrings to start with "Process ", "Assess ",
36-
or "Access ".
36+
or "Access ". To override different checks, add a field for each code in
37+
the form of ``override_<code>``.
3738

3839
``pyproject.toml``::
3940

@@ -48,16 +49,18 @@ the pre-commit hook as follows:
4849
'\.undocumented_method$',
4950
'\.__repr__$',
5051
]
51-
override_SS05 = '^((Process|Assess|Access) )'
52-
override_GL08 = '^(__init__)$'
52+
override_SS05 = [
53+
'^Process',
54+
'^Assess',
55+
'^Access',
56+
]
5357

5458
``setup.cfg``::
5559

5660
[tool:numpydoc_validation]
5761
checks = all,EX01,SA01,ES01
5862
exclude = \.undocumented_method$,\.__repr__$
59-
override_SS05 = ^((Process|Assess|Access) )
60-
override_GL08 = ^(__init__)$
63+
override_SS05 = ^Process,^Assess,^Access
6164

6265
For more fine-tuned control, you can also include inline comments to tell the
6366
validation hook to ignore certain checks:

0 commit comments

Comments
 (0)