-
Notifications
You must be signed in to change notification settings - Fork 99
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
suggestion: complete documentation #448
Comments
Overlaps #221 |
I'm new to JSDocs, and it seems like a pretty daunting task; there were 60 errors in that file alone. Any way this can be auto-generated or have a template for them to fill? |
It might seem more tedious than it is. It's more of a matter of explaining what the symbols do. The JSDoc documentation is a great reference. To see it in practice, look at the source code of |
You can also use the |
I suggest having documentation for every symbol within this project. One can check for remaining symbols missing documentation by running
deno doc --lint mod.ts
.The text was updated successfully, but these errors were encountered: