File tree Expand file tree Collapse file tree 1 file changed +8
-5
lines changed Expand file tree Collapse file tree 1 file changed +8
-5
lines changed Original file line number Diff line number Diff line change @@ -33,7 +33,8 @@ the pre-commit hook as follows:
33
33
* ``exclude ``: Don't report any issues on anything matching the regular
34
34
regular expressions ``\.undocumented_method$ `` or ``\.__repr__$ ``.
35
35
* ``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> ``.
37
38
38
39
``pyproject.toml ``::
39
40
@@ -48,16 +49,18 @@ the pre-commit hook as follows:
48
49
'\.undocumented_method$',
49
50
'\.__repr__$',
50
51
]
51
- override_SS05 = '^((Process|Assess|Access) )'
52
- override_GL08 = '^(__init__)$'
52
+ override_SS05 = [
53
+ '^Process',
54
+ '^Assess',
55
+ '^Access',
56
+ ]
53
57
54
58
``setup.cfg ``::
55
59
56
60
[tool:numpydoc_validation]
57
61
checks = all,EX01,SA01,ES01
58
62
exclude = \.undocumented_method$,\.__repr__$
59
- override_SS05 = ^((Process|Assess|Access) )
60
- override_GL08 = ^(__init__)$
63
+ override_SS05 = ^Process,^Assess,^Access
61
64
62
65
For more fine-tuned control, you can also include inline comments to tell the
63
66
validation hook to ignore certain checks:
You can’t perform that action at this time.
0 commit comments