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

Improve code comments #27

Open
edlee2121 opened this issue May 28, 2022 · 0 comments
Open

Improve code comments #27

edlee2121 opened this issue May 28, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@edlee2121
Copy link
Contributor

edlee2121 commented May 28, 2022 •
edited
Loading

Is your feature request related to a problem? Please describe.
Make it easier for new developers to read and understand the code.

Describe the solution you'd like
Add a block comment to each file and a comment for each method, type definition etc. describing the intended purpose for the code.

Describe alternatives you've considered
None

Additional context
None

Message from the maintainers:

If you wish to see this enhancement implemented please add a 👍 reaction to this issue! We often sort issues this way to know what to prioritize.
@edlee2121 edlee2121 added documentation Improvements or additions to documentation enhancement New feature or request labels May 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@edlee2121