password-validator icon indicating copy to clipboard operation
password-validator copied to clipboard

Published 20 hours ago • verified publisher icon tarunbatra

Improve JsDoc

Open tarunbatra opened this issue 6 years ago • 4 comments

Improve JsDoc to support suggestions in VScode.

Inspiration: #10 and #12.

tarunbatra avatar Oct 13 '17 20:10 tarunbatra

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.

katanacrimson avatar Jan 25 '18 19:01 katanacrimson

@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.

tarunbatra avatar Jan 29 '18 13:01 tarunbatra

@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

thakursaurabh1998 avatar Feb 11 '22 21:02 thakursaurabh1998

Makes sense @thakursaurabh1998. Thanks for the suggestion.

tarunbatra avatar Feb 12 '22 17:02 tarunbatra