Skip to content

Improve documentation for all public methods #167

@chris-greening

Description

@chris-greening

Is your feature request related to a problem? Please describe.
Some of the public facing docstrings aren't very comprehensive and could probably do with a bit of an upgrade

Describe the solution you'd like
Improve the documentation so all public facing features have appropriate docstrings, return types, type hints, etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions