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

Source Code Documentation #71

Open
malouro opened this issue Sep 9, 2020 · 0 comments
Open

Source Code Documentation #71

malouro opened this issue Sep 9, 2020 · 0 comments
Labels
documentation Adding or updating documentation

Comments

@malouro
Copy link
Owner

malouro commented Sep 9, 2020

There are many parts of the source code that are hard to figure out without decent comments or documentation. At the very least, utility functions & methods should have JSDoc comments for what the params are and what the resulting output is. Additionally, certain handlers are missing documentation.

@malouro malouro added the documentation Adding or updating documentation label Sep 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Adding or updating documentation
Projects
None yet
Development

No branches or pull requests

1 participant