docstring_parser icon indicating copy to clipboard operation
docstring_parser copied to clipboard

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

Open jsh9 opened this issue 2 years ago • 0 comments

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

In this issue (https://github.com/jsh9/pydoclint/issues/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.

jsh9 avatar Aug 18 '23 02:08 jsh9