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

[Google style] Parse "Yields" and "Returns" sections together #78

Open
jsh9 opened this issue Jun 5, 2023 · 0 comments
Open

[Google style] Parse "Yields" and "Returns" sections together #78

jsh9 opened this issue Jun 5, 2023 · 0 comments

Comments

@jsh9
Copy link

jsh9 commented Jun 5, 2023

Right now, when there are both Yields and Returns sections in the docstring, only the section on the top is parsed.

For example, in this docstring:

"""
Do something

Args:
    arg1 (int):

Yields:
    int: something

Returns:
    int: something else
"""

only the "Yields" section is parsed as DocstringReturns.

And in this docstring:

"""
Do something

Args:
    arg1 (int):

Returns:
    int: something

Yields:
    int: something else
"""

only the "Returns" section is parsed as DocstringReturns.

Is it possible to add a new class DocstringYields and also parse the "Yields" sections when both "Yields" and "Returns" exist in the docstring?

Thank you!

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