Skip to content
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

Closed
iuioiua opened this issue Feb 5, 2024 · 4 comments · Fixed by #451
Closed

suggestion: complete documentation #448

iuioiua opened this issue Feb 5, 2024 · 4 comments · Fixed by #451

Comments

@iuioiua
Copy link
Contributor

iuioiua commented Feb 5, 2024

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.

@iuioiua
Copy link
Contributor Author

iuioiua commented Feb 5, 2024

Overlaps #221

@bombillazo
Copy link
Collaborator

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?

@iuioiua
Copy link
Contributor Author

iuioiua commented Feb 5, 2024

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 deno_std—especially the collections sub-module.

@iuioiua
Copy link
Contributor Author

iuioiua commented Feb 5, 2024

You can also use the /doc command in GitHub Copilot.

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

Successfully merging a pull request may close this issue.

2 participants