File tree 2 files changed +8
-1
lines changed
2 files changed +8
-1
lines changed Original file line number Diff line number Diff line change @@ -64,4 +64,5 @@ a more detailed message. For example::
64
64
The full mapping of validation checks is given below.
65
65
66
66
.. literalinclude :: ../numpydoc/validate.py
67
- :lines: 36-90
67
+ :start-after: start-err-msg
68
+ :end-before: end-err-msg
Original file line number Diff line number Diff line change 34
34
"References" ,
35
35
"Examples" ,
36
36
]
37
+ # NOTE: The following comment is a sentinel for embedding in the docs - do not
38
+ # modify/remove
39
+ # start-err-msg
37
40
ERROR_MSGS = {
38
41
"GL01" : "Docstring text (summary) should start in the line immediately "
39
42
"after the opening quotes (not in the same line, or leaving a "
91
94
"SA04" : 'Missing description for See Also "{reference_name}" reference' ,
92
95
"EX01" : "No examples section found" ,
93
96
}
97
+ # end-err-msg
98
+ # NOTE: The above comment is a sentinel for embedding in the docs - do not
99
+ # modify/remove
94
100
95
101
# Ignore these when evaluating end-of-line-"." checks
96
102
IGNORE_STARTS = (" " , "* " , "- " )
You can’t perform that action at this time.
0 commit comments