File tree 1 file changed +6
-2
lines changed 1 file changed +6
-2
lines changed Original file line number Diff line number Diff line change @@ -97,9 +97,11 @@ This will validate that the docstring can be built.
97
97
For an exhaustive validation of the formatting of the docstring, use the
98
98
``--validate `` parameter. This will report the errors detected, such as
99
99
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.
101
103
102
- .. _validation_during_sphinx_build
104
+ .. _validation_during_sphinx_build :
103
105
104
106
Docstring Validation during Sphinx Build
105
107
----------------------------------------
@@ -149,6 +151,8 @@ The full mapping of validation checks is given below.
149
151
:start-after: start-err-msg
150
152
:end-before: end-err-msg
151
153
154
+ .. _inline_ignore_comments :
155
+
152
156
Ignoring Validation Checks with Inline Comments
153
157
-----------------------------------------------
154
158
You can’t perform that action at this time.
0 commit comments