Skip to content

Commit 163c273

Browse files
committed
docs(validation.rst,-install.rst): indicate relative path not absolute path for exclude_files options
1 parent dd626da commit 163c273

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

doc/install.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,11 +141,11 @@ numpydoc_validation_exclude : set
141141
``numpydoc_validation_checks`` is not an empty set.
142142
numpydoc_validation_exclude_files : set
143143
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.
145145
For example, to skip docstring validation for all objects in
146146
``tests\``::
147147

148-
numpydoc_validation_exclude_files = {"$.*tests/.*"}
148+
numpydoc_validation_exclude_files = {"^tests/.*$"}
149149

150150
The default is an empty set meaning no paths are excluded from docstring
151151
validation.

doc/validation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ the pre-commit hook as follows:
3636
expressions ``\.undocumented_method$`` or ``\.__repr__$``. This
3737
maps to ``numpydoc_validation_exclude`` from the
3838
: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
4141
``numpydoc_validation_exclude_files`` from the
4242
:ref:`Sphinx build configuration <validation_during_sphinx_build>`.
4343
* ``override_SS05``: Allow docstrings to start with "Process ", "Assess ",

0 commit comments

Comments
 (0)