Skip to content

Add documentation #91

Description

@DeD1rk

Only a small part of the code is currently documented. I think it would be good to document (through doc comments) a large part of the codebase. Especially:

  • Models and their fields.
  • Cubits, with in detail descriptions of what they do, and their public methods.

The UI does not need to be documented extensively, as it is not consumed by other parts of the code.

Metadata

Metadata

Assignees

Labels

choreSomething that is not a bug or a feature, does not change production behaviourdocsImprovements or additions to documentationpriority: highMust be dealt with before the next release is deployed.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions