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

Document API, parameters, and helper methods. #26

Merged
merged 3 commits into from Aug 9, 2014
Merged

Conversation

@totherik
Copy link
Contributor

totherik commented Aug 9, 2014

Hey @wpreul, I took a first stab to filling out documentation for this module. I tried to follow conventions found in other hapijs modules, such as joi, but if there's anything that looks out of whack just let me know.

Also, there is some redundancy around the convenience methods, so if you'd rather see that condensed I can make that change.

Finally, the current docs and tests indicate a downstreamRes option that doesn't appear to be used anywhere in code, so I did not include that configuration options in this documentation.

@geek

This comment has been minimized.

Copy link
Member

geek commented Aug 9, 2014

Perfect, thanks so much for the help!

geek added a commit that referenced this pull request Aug 9, 2014
Document API, parameters, and helper methods.
@geek geek merged commit aa44c09 into hapijs:master Aug 9, 2014
1 check passed
1 check passed
continuous-integration/travis-ci The Travis CI build passed
Details
@totherik

This comment has been minimized.

Copy link
Contributor Author

totherik commented Aug 9, 2014

Just realized there's copypasta errors in each of the convenience method docs. "DELETE" is referenced in each of them. Sorry about that. Not near a computer but will fix when I am if it isn't fixed by then.

@geek geek added the documentation label Aug 10, 2014
@geek geek self-assigned this Aug 10, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.