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 annotations, comments, and docstrings to source. #1373

Open
jakefrommars64 opened this issue Jul 24, 2024 · 0 comments
Open

Add annotations, comments, and docstrings to source. #1373

jakefrommars64 opened this issue Jul 24, 2024 · 0 comments

Comments

@jakefrommars64
Copy link

jakefrommars64 commented Jul 24, 2024

Is your feature request related to a problem? Please describe.

Go through the Foam source code and add annotations, comments, and docstrings that describe and detail what each part of the code is and does. Including parameters, potential references, and anything else that would be useful to improve the readability and navigability of the code.

The TypeScript team has already defined a docstring-like documentation standard

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