Handle asterisks better in Sphinx and Google style docstrings #6212
Conversation
This file contains 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
DanielNoord
added
Bug 🪲
Needs backport
Pierre-Sassoulas
approved these changes
Apr 7, 2022
Pull Request Test Coverage Report for Build 2107626860
💛 - Coveralls |
|
I think this warrants one final patch release on |
|
I'm waiting for #5822 to be merged to release the last patch. I burst between 2.13.5 and 2.13.6 to release sooner because there was a crash fix that was waiting for a long time already. |
Pierre-Sassoulas
added
Backported
and removed
Needs backport
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.
doc/whatsnew/<current release.rst>.Type of Changes
Description
Closes #5815, closes #5406.
See the tests for what is allowed now. Asterisks are no longer required and will be parsed correctly in Google style. I have chosen to fix this in the extension itself. Internally we still see the argument names including the asterisk, but when we finally check if we should emit the warning we also check whether the name without asterisks exists. If so, we don't emit.