File tree Expand file tree Collapse file tree 2 files changed +4
-4
lines changed Expand file tree Collapse file tree 2 files changed +4
-4
lines changed Original file line number Diff line number Diff line change @@ -141,11 +141,11 @@ numpydoc_validation_exclude : set
141
141
``numpydoc_validation_checks `` is not an empty set.
142
142
numpydoc_validation_exclude_files : set
143
143
A container of strings using :py:mod: `re ` syntax specifying path patterns to
144
- ignore for docstring validation.
144
+ ignore for docstring validation, relative to the package root .
145
145
For example, to skip docstring validation for all objects in
146
146
``tests\ ``::
147
147
148
- numpydoc_validation_exclude_files = {"$.* tests/.*"}
148
+ numpydoc_validation_exclude_files = {"^ tests/.*$ "}
149
149
150
150
The default is an empty set meaning no paths are excluded from docstring
151
151
validation.
Original file line number Diff line number Diff line change @@ -36,8 +36,8 @@ the pre-commit hook as follows:
36
36
expressions ``\.undocumented_method$ `` or ``\.__repr__$ ``. This
37
37
maps to ``numpydoc_validation_exclude `` from the
38
38
:ref: `Sphinx build configuration <validation_during_sphinx_build >`.
39
- * ``exclude_files ``: Exclude file paths matching the regular expressions
40
- ``^tests/.*$ `` or ``^module/gui.*$ ``. This maps to
39
+ * ``exclude_files ``: Exclude file paths (relative to the package root) matching
40
+ the regular expressions ``^tests/.*$ `` or ``^module/gui.*$ ``. This maps to
41
41
``numpydoc_validation_exclude_files `` from the
42
42
:ref: `Sphinx build configuration <validation_during_sphinx_build >`.
43
43
* ``override_SS05 ``: Allow docstrings to start with "Process ", "Assess ",
You can’t perform that action at this time.
0 commit comments