Skip to content

Missing docstrings #4

@tlunet

Description

@tlunet

Most docstring for function and classes are missing, this should be added in order to be automatically added to the online documentation here : https://marge-3d-solver.readthedocs.io/en/latest/api/marge3d/index.html

Don't hesitate to look at other examples online, for instance the [docstrings of qmat.lagrange] (https://github.com/Parallel-in-Time/qmat/blob/main/qmat/lagrange.py), that summarize most of the possible docstring formating (item lists, examples, math equations, etc ...)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions