graphql-mongo-helpers icon indicating copy to clipboard operation
graphql-mongo-helpers copied to clipboard

add JSDoc

Open Tsugami opened this issue 2 years ago • 4 comments

Tsugami avatar Oct 28 '21 16:10 Tsugami

+1

noghartt avatar Dec 17 '21 04:12 noghartt

can you provider more info about what do you expect? @Tsugami and @noghartt

daniloab avatar Dec 17 '21 12:12 daniloab

can you provider more info about what do you expect? @Tsugami and @noghartt

I think that JSDocs could be interesting to document some examples of uses of some functions and other things, like add comments like: @deprecated or others. It would be interesting because we can use JSDocs with Markdown, so we can pass some code blocks giving a clear example of how to use some function and other things like it.

noghartt avatar Dec 18 '21 02:12 noghartt

JSDoc is the best docs for a lib, you can adds: examples, tips, descriptions and links.

Tsugami avatar Dec 18 '21 21:12 Tsugami