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

Bettering the code documentation #256

Open
Pacmens opened this issue Jul 9, 2021 · 0 comments
Open

Bettering the code documentation #256

Pacmens opened this issue Jul 9, 2021 · 0 comments
Assignees
Labels
code quality Improving the quality/maintainability of the code

Comments

@Pacmens
Copy link
Collaborator

Pacmens commented Jul 9, 2021

When coming back to this project, I often had to ask myself why something was done a certain way. On some instances I still can't fully comprehend the underlying processes. This incomprehention goes so far that there is still points where I'm not sure why our code even works.

The goal here is to add adequate documentation to as many of those places as possible.

The primary method of this will be comments, but there may be some other means to employ

@Pacmens Pacmens added this to the Hera Beta Cleanup milestone Jul 9, 2021
@Pacmens Pacmens self-assigned this Jul 9, 2021
@Pacmens Pacmens added code quality Improving the quality/maintainability of the code and removed maintenance labels Jul 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality Improving the quality/maintainability of the code
Projects
None yet
Development

No branches or pull requests

1 participant