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

Code documentation #691

Open
Marmingen opened this issue Nov 13, 2022 · 0 comments
Open

Code documentation #691

Marmingen opened this issue Nov 13, 2022 · 0 comments
Labels
enhancement Lowest Lowest priority

Comments

@Marmingen
Copy link
Collaborator

Description

The documentation is lacking. General descriptions of the frameworks and docker at docs.utn.se and github respectively are OK, but the in-code documentation is almost non-existent.

Fix:
Document what the classes and functions in the code are used for unless it's obvious in the form of docstrings and comments where needed.
@Marmingen Marmingen added enhancement Lowest Lowest priority labels Nov 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Lowest Lowest priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Marmingen