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

docs(README): clarify API #261

Merged
merged 2 commits into from
Oct 29, 2018
Merged

docs(README): clarify API #261

merged 2 commits into from
Oct 29, 2018

Conversation

cdtinney
Copy link
Contributor

Clarifies API usage via displaying function signatures with named parameters.

Resolves #184

@coveralls
Copy link

coveralls commented Oct 27, 2018 •
edited
Loading

Coverage Status

Coverage remained the same at 88.877% when pulling 1a90da5 on cdtinney:docs-clarify-api into 179febf on algolia:master.

Haroenv
Haroenv approved these changes Oct 28, 2018
View reviewed changes
Copy link
Contributor

@Haroenv Haroenv left a comment

Choose a reason for hiding this comment

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

this makes sense to me, what do you think @vvo?

@Haroenv Haroenv merged commit b6539d3 into algolia:master Oct 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Haroenv Haroenv Haroenv approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cdtinney @coveralls @Haroenv