Conversation
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.
Fixes GH-115. A Google docstring with no summary line, opening straight with
Args:, came back with zero params:inspect.cleandocstrips only the first line and dedents the rest, so the entries ended up flush with the title, the section was cut empty andGoogleParser.parseraisedParseError. In auto mode that is swallowed and the REST parse with nothing in it wins.The parser now pushes a first-line title below a newline before
cleandoc, so the title is dedented together with its entries. Docstrings with a summary or with a blank first line are untouched. Numpydoc and reST never had the problem since their entries sit at the title's indent.Tests: a params and a returns case in test_google.py, and the auto-detection case in test_parser.py. Suite green on 3.8 and 3.12, pre-commit tools clean.