tolerate square brackets in return type annotations #36
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.
Currently, sphinx-doc does not create docstrings when return type annotations contain square brackets.
Example:
Steps to reproduce:
M-x sphinx-doc RET
.Expected results:
A docstring should appear.
Actual results:
The buffer is unchanged and the following message is logged:
Failed to parse function definition ’def test(a, b) -> Optional[str]:’.
This PR modifies the return type regex to tolerate square brackets in return type annotations and adds a corresponding test.