Repository navigation
numpydoc: report short title underlines - #187
Merged
Merged
Conversation
A section title's underline could be any length. It now needs at least three dashes or equals signs, or the parser's min_underline. With exact_underline, it must be as long as the title. A declared title whose underline breaks the rule is still read as its section, with a bad-underline problem, which strict parsing raises.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A Numpydoc section title's underline used to be accepted at any length. By default it now needs at least three dashes or equals signs.
NumpydocParsertakes two new options:min_underline: int = 3, the shortest underline allowed.exact_underline: bool = False. When true, the underline must be exactly as long as the title.A declared title whose underline breaks the rule is still read as its section, and the parser reports a new
bad-underlineproblem.try_parse()returns it, andparse()raises it asParseError. The code is documented with the other problem codes onProblem.Case diffs: none. Parity against origin/main: 0 of 29184 docstrings differ (case 0, stdlib 0, generated 0). No case or stdlib docstring reports
bad-underline.