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

Line breaks in Args will generate new arguments #16

Open
neozhaoliang opened this issue Feb 18, 2022 · 0 comments
Open

Line breaks in Args will generate new arguments #16

neozhaoliang opened this issue Feb 18, 2022 · 0 comments

Comments

@neozhaoliang
Copy link
Contributor

neozhaoliang commented Feb 18, 2022

When a line in Args is too long, we want to break it into several short lines. But currently, sphinx will parse the new lines as arguments.

Example:

What we want:

"""
Args:
    x: blblblblblblbla
        blblblblblblbla (we can put a long description string into multiple lines here)
"""

But the parsed result look like:

x :

bl: 

Sphinx will think the new line under x as a new argument. Can we fix this?

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