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

Consistant API documentation in README #57

Closed
mikeymike opened this issue Nov 4, 2016 · 0 comments
Closed

Consistant API documentation in README #57

mikeymike opened this issue Nov 4, 2016 · 0 comments
Labels
help wanted

Comments

@mikeymike
Copy link
Member

As @bmitch pointed out in #55 it does seem a little inconsistent between when we're showing a full example and a snippet of code.

Maybe this is just a case of adding something like ... snip to the smaller API examples to make it more clear.

@AydinHassan thoughts?
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mikeymike @AydinHassan