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

Improve JsDoc #13

Open
tarunbatra opened this issue Oct 13, 2017 · 4 comments
Open

Improve JsDoc #13

tarunbatra opened this issue Oct 13, 2017 · 4 comments
Labels

Comments

@tarunbatra
Copy link
Owner

Improve JsDoc to support suggestions in VScode.

Inspiration: #10 and #12.

@katanacrimson
Copy link

katanacrimson commented Jan 25, 2018

Current JSDoc is also incorrect and seems to omit has() and not() argument details.

Also, not() seems to have an optional argument that is not marked optional even in the readme, but appears optional based on the provided example.

@tarunbatra
Copy link
Owner Author

tarunbatra commented Jan 29, 2018

@damianb

  1. You are right; the params are missing. Thanks for the comment, it will help tracking the issue.
  2. Ah, the param is marked optional using the square brackets around them, but not explicitly by mentioning optional as in the documentation of has. I think it's better to drop the explicit mention to be consistent.

@thakursaurabh1998
Copy link
Contributor

@tarunbatra Adding the label good-first-issue will lead to listing of your repo in this page: https://github.com/topics/good-first-issue and someone interested for the good first issues might come and help :D

@tarunbatra
Copy link
Owner Author

Makes sense @thakursaurabh1998. Thanks for the suggestion.

@tarunbatra tarunbatra added the good first issue Beginner friendly issue label Feb 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants