writer icon indicating copy to clipboard operation
writer copied to clipboard

Numpy docstring not correctly indented

Open arunoruto opened this issue 1 year ago • 0 comments

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.

arunoruto avatar Feb 13 '24 16:02 arunoruto