Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add additional per-request configuration documentation #876

Merged

Conversation

joeltaylor
Copy link
Contributor

Came across another issue (#871) where someone was confused by the per-request configuration syntax.

Figured I would take a stab at adding some explicit documentation.

Copy link
Contributor

@brandur-stripe brandur-stripe left a comment

Choose a reason for hiding this comment

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

Minor comment, but LGTM!

- When operating on a collection (e.g. `.list`, `.create`) the method signature is
`method(params, opts)`.
- When operating on resource (e.g. `.capture`, `.update`) the method signature is
`method(id, params, opts)`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Just for cleanliness, can we keep consistent indentation for each bullet? (First two indent at two spaces and the last one indents at three.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Whoops, thanks for catching that!

@joeltaylor joeltaylor force-pushed the update-per-request-config-documentation branch from c9ac54d to ecccd5a Compare November 1, 2019 12:46
@ob-stripe ob-stripe merged commit 93ea15f into stripe:master Nov 1, 2019
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants