Skip to content

Commit e857c12

Browse files
committed
Move note in docs on inline comments to its own section now that both sides support it.
1 parent bb311e8 commit e857c12

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

doc/validation.rst

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,17 +62,6 @@ the pre-commit hook as follows:
6262
exclude = \.undocumented_method$,\.__repr__$
6363
override_SS05 = ^Process,^Assess,^Access
6464

65-
For more fine-tuned control, you can also include inline comments to tell the
66-
validation hook to ignore certain checks:
67-
68-
.. code-block:: python
69-
70-
class SomeClass: # numpydoc ignore=EX01,SA01,ES01
71-
"""This is the docstring for SomeClass."""
72-
73-
def __init__(self): # numpydoc ignore=GL08
74-
pass
75-
7665
If any issues are found when commiting, a report is printed out and the
7766
commit is halted:
7867

@@ -159,3 +148,17 @@ The full mapping of validation checks is given below.
159148
.. literalinclude:: ../numpydoc/validate.py
160149
:start-after: start-err-msg
161150
:end-before: end-err-msg
151+
152+
Ignoring Validation Checks with Inline Comments
153+
-----------------------------------------------
154+
155+
For more fine-tuned control, you can also include inline comments
156+
to ignore certain checks:
157+
158+
.. code-block:: python
159+
160+
class SomeClass: # numpydoc ignore=EX01,SA01,ES01
161+
"""This is the docstring for SomeClass."""
162+
163+
def __init__(self): # numpydoc ignore=GL08
164+
pass

0 commit comments

Comments
 (0)