Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix validation include line numbers #418

Merged
merged 3 commits into from
Jul 18, 2022
Merged

docs: fix validation include line numbers #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ca0bf6
docs: fix validation include line numbers
thatlittleboy Jul 18, 2022
c5f4f0f
use start/end markers instead of hardcoding lineno
thatlittleboy Jul 18, 2022
2f7c67b
Add missing sentinel + explanatory comment.
rossbar Jul 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/validation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,5 @@ a more detailed message. For example::
The full mapping of validation checks is given below.

.. literalinclude:: ../numpydoc/validate.py
:lines: 36-90
:start-after: start-err-msg
:end-before: end-err-msg
6 changes: 6 additions & 0 deletions numpydoc/validate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
"References",
"Examples",
]
# NOTE: The following comment is a sentinel for embedding in the docs - do not
# modify/remove
# start-err-msg
ERROR_MSGS = {
"GL01": "Docstring text (summary) should start in the line immediately "
"after the opening quotes (not in the same line, or leaving a "
Expand Down Expand Up @@ -91,6 +94,9 @@
"SA04": 'Missing description for See Also "{reference_name}" reference',
"EX01": "No examples section found",
}
# end-err-msg
# NOTE: The above comment is a sentinel for embedding in the docs - do not
# modify/remove

# Ignore these when evaluating end-of-line-"." checks
IGNORE_STARTS = (" ", "* ", "- ")
Expand Down