Skip to content

Please provide helpful docstrings #20

@MarcSkovMadsen

Description

@MarcSkovMadsen

Many of the core classes lack useful docstrings. This makes it harder to use than it has to.

Please add proper numpy style docstrings that Sphinx can autogenerate reference docs from and that works well in VS Code tooltips. Please include one or more examples. Scope is public API.

Example

Image

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions