search

woovibr / graphql-mongo-helpers

GraphQL + MongoDB helpers that scale
MIT License
83 stars 7 forks source link

add JSDoc #256

Open Tsugami opened 3 years ago

noghartt commented 2 years ago

+1

daniloab commented 2 years ago

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

noghartt commented 2 years ago

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.

Tsugami commented 2 years ago

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