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

Fix API docs - should be settings.confg #187

Closed
lholmquist opened this issue Jan 10, 2020 · 0 comments · Fixed by #188
Closed

Fix API docs - should be settings.confg #187

lholmquist opened this issue Jan 10, 2020 · 0 comments · Fixed by #188

Comments

@lholmquist
Copy link
Member

lholmquist commented Jan 10, 2020

The API docs are not totally correct. For example, if a user needs to pass in some custom config values, if they were to look at the docs, it looks like this should be passed in:

  { key1: value, key2: value }

when it should be

  {
    config: { key1: value, key2: value }
  }

The readme is correct, this is a simple API doc fix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant