File tree 1 file changed +14
-0
lines changed
1 file changed +14
-0
lines changed Original file line number Diff line number Diff line change @@ -138,3 +138,17 @@ numpydoc_validation_exclude : set
138
138
validation.
139
139
Only has an effect when docstring validation is activated, i.e.
140
140
``numpydoc_validation_checks `` is not an empty set.
141
+ numpydoc_validation_overrides : dict
142
+ A dictionary mapping :ref: `validation checks <validation_checks >` to a
143
+ container of strings using :py:mod: `re ` syntax specifying patterns to
144
+ ignore for docstring validation.
145
+ For example, to skip the ``SS02 `` check for docstrings starting with
146
+ the word ``Process ``::
147
+
148
+ numpydoc_validation_overrides = {"SS02": [r'^Process ']}
149
+
150
+ The default is an empty dictionary meaning no overrides.
151
+ Only has an effect when docstring validation is activated, i.e.
152
+ ``numpydoc_validation_checks `` is not an empty set. Use
153
+ :ref: `inline ignore comments <inline_ignore_comments >` to turn off
154
+ specific checks for parts of your code.
You can’t perform that action at this time.
0 commit comments