Skip to content

Numpy docstring not correctly indented #134

@arunoruto

Description

@arunoruto

I am currently trying the writer to have a base documentation for my package and so far so good, except for the indentation of the docstrings. For example I get a docstring which looks like this:

'''The function initializes the simulation object and sets up arrays for storing complex values.

Parameters
----------
simulation : Simulation
    The `simulation` parameter is an instance of the `Simulation` class. It is being passed to the
`__init__` method as an argument.

so the __ini__ is recognized as a new parameter, due to it not being indented correctly:

'''The function initializes the simulation object and sets up arrays for storing complex values.

Parameters
----------
simulation : Simulation
    The `simulation` parameter is an instance of the `Simulation` class. It is being passed to the
    `__init__` method as an argument.

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