Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add JSDoc #256

Open
Tsugami opened this issue Oct 28, 2021 · 4 comments
Open

add JSDoc #256

Tsugami opened this issue Oct 28, 2021 · 4 comments

Comments

@Tsugami
Copy link

Tsugami commented Oct 28, 2021

No description provided.

@noghartt
Copy link
Contributor

+1

@daniloab
Copy link

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

@noghartt
Copy link
Contributor

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
Copy link
Author

Tsugami commented Dec 18, 2021

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

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

No branches or pull requests

3 participants