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

Add in-code comments where helpful #17

Open
patrickmj opened this issue Jun 5, 2023 · 0 comments
Open

Add in-code comments where helpful #17

patrickmj opened this issue Jun 5, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation Immediately actionable wrapup task

Comments

@patrickmj
Copy link
Collaborator

For this project (and generally, IMHO), in-code comments should be used primarily for detailed explanation of how something complicated works. Rule of thumb is that if it takes more than 15 minutes to figure out, or if you did research to find a solution, those should be in the in-code docs, with links.

Do that in as many places as possible.

If the same idea applies to an entire file or folder, add it as a README (or other markdown file) to the containing folder.

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 Immediately actionable wrapup task
Projects
None yet
Development

No branches or pull requests

2 participants