You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
so the
__ini__
is recognized as a new parameter, due to it not being indented correctly:The text was updated successfully, but these errors were encountered: