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

Node-by-node documentation for all modules in the library #35

Open
markalanboyd opened this issue Sep 23, 2022 · 0 comments
Open

Node-by-node documentation for all modules in the library #35

markalanboyd opened this issue Sep 23, 2022 · 0 comments

Comments

@markalanboyd
Copy link
Contributor

I intend to create node-by-node documentation, akin to commenting every line of code, for every module in the library.

The purpose would be to make the modules as discoverable and readable as possible for people who would like to learn how they work.

The benefit of this would be that people could learn how things are made and take the concepts they learn and make new things. Conversely, someone might be able to read what is happening in a patch and realize from a text description that there is perhaps a more efficient or elegant way to do the same thing and suggest an enhancement or fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant