Skip to content

Improve API documentation #22

Description

@AdrianBenson

API documentation requires improvement

  • Ensure docstrings consistent with function/class signatures
  • Break API docs into logical sections (e.g. Observations, Reductions) - consider separate pages fro each section
  • Provide some text to describe sections
  • Reorder elements to reflect usage patterns
  • Remove type annotations from method in docs

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions