Skip to content

Commit c2e7ddc

Browse files
committed
Add note on inline comment usage for --validate.
1 parent 0c20e87 commit c2e7ddc

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

doc/validation.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,11 @@ This will validate that the docstring can be built.
9797
For an exhaustive validation of the formatting of the docstring, use the
9898
``--validate`` parameter. This will report the errors detected, such as
9999
incorrect capitalization, wrong order of the sections, and many other
100-
issues.
100+
issues. Note that this will honor :ref:`inline ignore comments <inline_ignore_comments>`,
101+
but will not look for any configuration like the pre-commit hook or Sphinx
102+
extension do.
101103

102-
.. _validation_during_sphinx_build
104+
.. _validation_during_sphinx_build:
103105

104106
Docstring Validation during Sphinx Build
105107
----------------------------------------
@@ -149,6 +151,8 @@ The full mapping of validation checks is given below.
149151
:start-after: start-err-msg
150152
:end-before: end-err-msg
151153

154+
.. _inline_ignore_comments:
155+
152156
Ignoring Validation Checks with Inline Comments
153157
-----------------------------------------------
154158

0 commit comments

Comments
 (0)