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 comments for public-facing API #173

Open
1 of 4 tasks
hatemhosny opened this issue Aug 31, 2024 · 0 comments
Open
1 of 4 tasks

Add JSDoc comments for public-facing API #173

hatemhosny opened this issue Aug 31, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest

Comments

@hatemhosny
Copy link
Owner

hatemhosny commented Aug 31, 2024

  • I'm submitting a ...

    • bug report
    • feature request
    • question about the decisions made in the repository
    • question about how to use this project
  • Summary

Add JSDoc comments, with descriptions, usage guides, examples, code samples and links to docs.

This can significantly improve the developer experience for the library users.

Most of the content can be found in the docs

@hatemhosny hatemhosny added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

1 participant