Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation #91

Open
DeD1rk opened this issue Aug 6, 2021 · 0 comments
Open

Add documentation #91

DeD1rk opened this issue Aug 6, 2021 · 0 comments
Assignees
@Scarletto
Labels
chore Something that is not a bug or a feature, does not change production behaviour docs Improvements or additions to documentation priority: high Must be dealt with before the next release is deployed.

Comments

@DeD1rk
Copy link
Member

DeD1rk commented Aug 6, 2021

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.
@DeD1rk DeD1rk added chore Something that is not a bug or a feature, does not change production behaviour docs Improvements or additions to documentation priority: low Should be dealt with when nothing else remains. labels Aug 6, 2021
@JeeVee11 JeeVee11 added priority: high Must be dealt with before the next release is deployed. and removed priority: low Should be dealt with when nothing else remains. labels Oct 12, 2022
@Scarletto Scarletto self-assigned this Apr 27, 2023
@Scarletto Scarletto added request-for-comments Author wants to have other people respond for their opinion and removed request-for-comments Author wants to have other people respond for their opinion labels Apr 27, 2023
@Scarletto Scarletto mentioned this issue Apr 27, 2023
Draft
58 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Scarletto Scarletto

Labels
chore Something that is not a bug or a feature, does not change production behaviour docs Improvements or additions to documentation priority: high Must be dealt with before the next release is deployed.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Scarletto @DeD1rk @JeeVee11