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

Enhancement Report: Improve commenting of code and docs #7

Closed
Moosems opened this issue Aug 17, 2024 · 0 comments · Fixed by #4
Closed

Enhancement Report: Improve commenting of code and docs #7

Moosems opened this issue Aug 17, 2024 · 0 comments · Fixed by #4
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Moosems
Copy link
Member

Moosems commented Aug 17, 2024

Enhancement report:

Comments shouldn't be used to explain what a line is doing, but what the purpose of the code is. Better commenting is absolutely critical for writing good docs and getting help from others and that's something I also want to set a good example for.

My docs are kinda good but they don't outline everything as good as they should. Class init arguments should be mentioned for sure.

@Moosems Moosems added the bug Something isn't working label Aug 17, 2024
@Moosems Moosems added this to the v0.3.0 milestone Aug 17, 2024
@Moosems Moosems self-assigned this Aug 17, 2024
@Moosems Moosems added documentation Improvements or additions to documentation and removed bug Something isn't working labels Aug 17, 2024
@Moosems Moosems mentioned this issue Sep 7, 2024
7 tasks
@Moosems Moosems closed this as completed in #4 Sep 7, 2024
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.

1 participant