denodrivers / postgres

PostgreSQL driver for Deno

Home Page:https://denodrivers.github.io/postgres

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

suggestion: complete documentation

iuioiua opened this issue · comments

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.

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

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