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.

Sign up for GitHub

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

Jump to bottom

(apparently) our in-line comments and JSDocs are rubbish! :-( #203

Closed
nelsonic opened this issue Oct 26, 2016 · 0 comments · Fixed by #214
Closed

(apparently) our in-line comments and JSDocs are rubbish! :-( #203

nelsonic opened this issue Oct 26, 2016 · 0 comments · Fixed by #214
Labels
help wanted priority-1

Comments

@nelsonic
Copy link
Member

While we have made the effort to make the readme docs good, annoyingly we don't have particularly good in-line comments or "JSDocs"
see: https://inch-ci.org/github/dwyl/hapi-auth-jwt2/suggestions?branch=master Inline docs

relates to: dwyl/repo-badges#17
@nelsonic nelsonic mentioned this issue Nov 19, 2016
Closed
nelsonic added a commit that referenced this issue Nov 23, 2016
@nelsonic
add JSDoc comments to ALL the methods in /lib/index.js to ensure we h…
8329c0c 
…ave decent docs! fixes #203
@nelsonic nelsonic mentioned this issue Nov 23, 2016
Merged
nelsonic added a commit that referenced this issue Nov 23, 2016
@nelsonic
adds "Inch-CI" badge to readme. see #203 and dwyl/repo-badges#17
ae3223d
nelsonic added a commit that referenced this issue Nov 23, 2016
@nelsonic
improve code-level documentation for clarity. no API changes (only do…
a7abaef 
…cs updated). no upgrade required. see: #203
This was referenced Nov 23, 2016
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted priority-1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add JSDoc comments to ALL the methods in /lib/index.js dwyl/hapi-auth-jwt2
1 participant
@nelsonic