Skip to content

Review and update API docs #5282

Open
Open
@OriolAbril

Description

@OriolAbril

We need to make sure all our public api is documented and that they are documented at the recommended import path. #5266 updated the distributions subsection (but I did not check there were no distributions missing) and can be used as template.

Note: if there are functions/classes that are not (or should not be) part of the public api but you think it would be helpful (even if only to you) to have a rendered version of their docstring on the website list them here too. I am considering adding a private api subsection within the contributing section

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions