Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug in Google style] Return type parsed incorrectly with a | b style #81

Open
jsh9 opened this issue Aug 18, 2023 · 0 comments
Open

[Bug in Google style] Return type parsed incorrectly with a | b style #81

jsh9 opened this issue Aug 18, 2023 · 0 comments

Comments

@jsh9
Copy link

jsh9 commented Aug 18, 2023

Hi, I'm the developer of pydoclint, which uses docstring_parser to parse Google-style and Sphinx-style docstrings.

In this issue (jsh9/pydoclint#66), we found that docstring_parser encountered an issue if the return type is something like a | b.

For example:

Returns:
    Foo | int: Some description.

But if the return type is Union[a, b], the parsing is correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant