File tree Expand file tree Collapse file tree 1 file changed +14
-11
lines changed Expand file tree Collapse file tree 1 file changed +14
-11
lines changed Original file line number Diff line number Diff line change @@ -62,17 +62,6 @@ the pre-commit hook as follows:
62
62
exclude = \.undocumented_method$,\.__repr__$
63
63
override_SS05 = ^Process,^Assess,^Access
64
64
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
-
76
65
If any issues are found when commiting, a report is printed out and the
77
66
commit is halted:
78
67
@@ -159,3 +148,17 @@ The full mapping of validation checks is given below.
159
148
.. literalinclude :: ../numpydoc/validate.py
160
149
:start-after: start-err-msg
161
150
: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
You can’t perform that action at this time.
0 commit comments