Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Numpy docstring not correctly indented #134

Open
arunoruto opened this issue Feb 13, 2024 · 0 comments
Open

Numpy docstring not correctly indented #134

arunoruto opened this issue Feb 13, 2024 · 0 comments

Comments

@arunoruto
Copy link

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant