denodrivers/postgres

suggestion: complete documentation

Closed this issue · 4 comments

iuioiua commented

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 commented

Overlaps #221

bombillazo commented

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 commented

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.

  • 👀1
iuioiua commented

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