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.

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

Update code documentation #331

Open
andreaskrath opened this issue Oct 24, 2023 · 0 comments
Open

Update code documentation #331

andreaskrath opened this issue Oct 24, 2023 · 0 comments

Comments

@andreaskrath
Copy link
Contributor

andreaskrath commented Oct 24, 2023

Description

There are some parts of the code that do not have extensive and thorough documentation, like:

  • Correct and up to date summary
  • Parameters explanation
  • Exceptions

An example of poor documentation can be seen in the one of the constructors for the Week model.

Resolving this issue would be a large project, as it would involve going through the code base and understanding it thoroughly, before updating the provided descriptions and more.

It is likely that this issue only makes sense to complete after or as part of #326

Possible Suggested Solution

  • Update documentation for classes, methods and properties.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants