Detect docstring style mismatches by parsing, not by pattern - #321
Merged
Conversation
The style check matched a hand-written list of section headers per style. The list could not track what the parsers actually read: it treated a numpy Examples section as proof of numpy style, though that section is ordinary rST found in docstrings of every style, and it stayed silent on headers absent from the list. Ask the parsers instead. For each docstring the check collects the section kinds every style reads, and warns when a rival style reads a kind the configured one misses, naming both. This reports a foreign section sitting beside native ones, which the old rule suppressed, and stays silent on docstrings genuinely written in the configured style. Reject a configured parser outside numpy, google and sphinx with one config error rather than a warning on every docstring.
Member
|
I've made a small change. The |
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
2 participants
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.
This PR replaces the docstring style-mismatch lint check with one that asks the parsers what they read instead of matching a hand-written list of section headers per style. The list could not track what the parsers actually do: it treated a numpy Examples section as proof of numpy style, though that section is ordinary rST found in docstrings of every style, and it stayed silent on any header absent from the list. e.t.c. Now, linting can tell you if a docstring will silently lose structure because of the parser that will be used.