From 6711ab3b308ae60a0f73e7d8ee5db0d6e6b36828 Mon Sep 17 00:00:00 2001 From: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Date: Wed, 8 May 2024 17:36:12 -0400 Subject: [PATCH] DOC: Add note about TOML regex; fix typo (#552) Add note about TOML regex; fix typo --- doc/validation.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/validation.rst b/doc/validation.rst index 858a67cc..aa9d5236 100644 --- a/doc/validation.rst +++ b/doc/validation.rst @@ -33,7 +33,7 @@ the pre-commit hook as follows: ``ES01`` (using the same logic as the :ref:`validation during Sphinx build ` for ``numpydoc_validation_checks``). * ``exclude``: Don't report issues on objects matching any of the regular - regular expressions ``\.undocumented_method$`` or ``\.__repr__$``. This + expressions ``\.undocumented_method$`` or ``\.__repr__$``. This maps to ``numpydoc_validation_exclude`` from the :ref:`Sphinx build configuration `. * ``override_SS05``: Allow docstrings to start with "Process ", "Assess ", @@ -52,6 +52,7 @@ the pre-commit hook as follows: "SA01", "ES01", ] + # remember to use single quotes for regex in TOML exclude = [ # don't report on objects that match any of these regex '\.undocumented_method$', '\.__repr__$',