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 to ALL the methods in /lib/index.js #214

Merged
merged 4 commits into from
Nov 24, 2016

Conversation

nelsonic
Copy link
Member

A couple of people have (informally) mentioned that they find the plugin difficult to "follow".
This PR:

@iteles please review and let me know if OK. thanks! 👍

@codecov-io
Copy link

codecov-io commented Nov 23, 2016

Current coverage is 100% (diff: 100%)

Merging #214 into master will not change coverage

@@           master   #214   diff @@
====================================
  Files           2      2          
  Lines         108    108          
  Methods         0      0          
  Messages        0      0          
  Branches        0      0          
====================================
  Hits          108    108          
  Misses          0      0          
  Partials        0      0          

Powered by Codecov. Last update f55e939...1e77329


/**
* register registers the name and exposes the implementation of the plugin
* see: http://hapijs.com/api#serverplugins for plugin format
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super useful addition 👍

@iteles
Copy link
Member

iteles commented Nov 24, 2016

Thanks for this! JSDoc comments are very useful from my (and every beginner ever's) perspective. 👍

@iteles iteles merged commit 5e09733 into master Nov 24, 2016
@iteles iteles deleted the inch-ci-documentation-issue-203 branch November 24, 2016 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(apparently) our in-line comments and JSDocs are rubbish! :-(
3 participants