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 devdocs for important internal functions #1274

Open
10 tasks
ToucheSir opened this issue Jul 31, 2022 · 2 comments
Open
10 tasks

Add devdocs for important internal functions #1274

ToucheSir opened this issue Jul 31, 2022 · 2 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed up for grabs anyone is welcome to contribute with a PR to fix the issue

Comments

@ToucheSir
Copy link
Member

These may be as simple as a couple lines of comments, but as noted in #1243 (comment) they would be good to have:

@ToucheSir ToucheSir added help wanted Extra attention is needed good first issue Good for newcomers up for grabs anyone is welcome to contribute with a PR to fix the issue labels Jul 31, 2022
@DrChainsaw
Copy link

One more shower thought kinda proposal:

A PR checklist template (you know, the standard "[] Tests have been added" etc.) with a bullet saying something like "[] Every (undocumented) piece of code which took me more than five minutes to understand has a comment with the understanding I gained". Maybe a silly idea, I don't know...

@ToucheSir
Copy link
Member Author

A checklist is a good idea and one we should've had for a while. Copied over Flux's in #1275 with a small admonition to document changes to existing functionality as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed up for grabs anyone is welcome to contribute with a PR to fix the issue
Projects
None yet
Development

No branches or pull requests

2 participants