Skip to content

Commit 6711ab3

Browse files
authored
DOC: Add note about TOML regex; fix typo (#552)
Add note about TOML regex; fix typo
1 parent e7c6baf commit 6711ab3

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/validation.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ the pre-commit hook as follows:
3333
``ES01`` (using the same logic as the :ref:`validation during Sphinx build
3434
<validation_during_sphinx_build>` for ``numpydoc_validation_checks``).
3535
* ``exclude``: Don't report issues on objects matching any of the regular
36-
regular expressions ``\.undocumented_method$`` or ``\.__repr__$``. This
36+
expressions ``\.undocumented_method$`` or ``\.__repr__$``. This
3737
maps to ``numpydoc_validation_exclude`` from the
3838
:ref:`Sphinx build configuration <validation_during_sphinx_build>`.
3939
* ``override_SS05``: Allow docstrings to start with "Process ", "Assess ",
@@ -52,6 +52,7 @@ the pre-commit hook as follows:
5252
"SA01",
5353
"ES01",
5454
]
55+
# remember to use single quotes for regex in TOML
5556
exclude = [ # don't report on objects that match any of these regex
5657
'\.undocumented_method$',
5758
'\.__repr__$',

0 commit comments

Comments
 (0)