Skip to content
This repository was archived by the owner on Apr 26, 2023. It is now read-only.
This repository was archived by the owner on Apr 26, 2023. It is now read-only.

wrong rendering of multi-line "Return" section #4

@carlodri

Description

@carlodri

My source docstring inside a class method (correct indent of multiple lines):

        Returns:
            ndarray: a 2-D ``int16`` numpy array with dimensions :math:`(n_e, 2)` where
                the rows represent the :math:`(x, y)` coordinates of the :math:`n_e` events
                detected in the frame.

renders badly in this way:

image

whereas if I change it to this (wrong indentation of multiple lines):

        Returns:
            ndarray: a 2-D ``int16`` numpy array with dimensions :math:`(n_e, 2)` where
            the rows represent the :math:`(x, y)` coordinates of the :math:`n_e` events
            detected in the frame.

it renders correctly to:

image

I'm using the sphinx_rtd_theme but a similar issue occurs with the default alabaster theme.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions