Skip to content

Line breaks in Args will generate new arguments #16

@neozhaoliang

Description

@neozhaoliang

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions