ENH: Handle union type expressions for Google style docstrings#443
Merged
kernc merged 1 commit intopdoc3:masterfrom Jun 22, 2024
Merged
Conversation
e3f23b7 to
7686f66
Compare
7686f66 to
5bdeee9
Compare
Member
|
Looks good, thanks! |
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 fixes issue #441 by tweaking the regex expression used to parse Google-style docstrings to handle union-type expressions correctly.
I also updated the test for this docstring format to ensure the fix works as expected and prevent regressions in the future.