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

docs: add clear and more descriptive comments #51

Closed
4 tasks
jaybxyz opened this issue Oct 1, 2021 · 0 comments · Fixed by #53
Closed
4 tasks

docs: add clear and more descriptive comments #51

jaybxyz opened this issue Oct 1, 2021 · 0 comments · Fixed by #53
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jaybxyz
Copy link
Contributor

jaybxyz commented Oct 1, 2021

Summary

Add clear and descriptive comments on all the functions and logics.

Problem Definition

Some of the methods are missing comments and some logics need an explanation about why they should be that way.

Proposal

Scan through all the files in budget module and add or update comments to have clear and descriptive comments.

Tasks

  • scan through client folder to improve comments
  • scan through keeper folder to improve comments
  • scan through simulation folder to improve comments
  • scan through types folder to improve comments

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@jaybxyz jaybxyz added the documentation Improvements or additions to documentation label Oct 1, 2021
@jaybxyz jaybxyz added this to the Budget v1.0 milestone Oct 1, 2021
@jaybxyz jaybxyz changed the title docs: add clear and descriptive comments docs: add clear and more descriptive comments Oct 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants