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

Revise docs and formatting for accounts.ex #79

Merged
merged 1 commit into from
Aug 18, 2016
Merged

Revise docs and formatting for accounts.ex #79

merged 1 commit into from
Aug 18, 2016

Conversation

gmile
Copy link
Contributor

@gmile gmile commented Aug 17, 2016

In this PR I normalize the docs formatting and spelling, particularly:

  • use 4 spaces for code examples,
  • use lowercase letters when referencing API entity, e.g. account instead of Account,
  • making note about using custom Stripe API key consistent, e.g. use "Accepts Stripe API key.
    " everywhere,
  • in examples depicting usage of custom Stripe API key – use a string "my_key" instead of key variable – this is to better indicate that library users must provide their own custom string.

year: 1991
## Examples

params = [
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm using 4 spaces, as this seems to preferred way of styling the docs (per examples from Elixir codebase).

@coveralls
Copy link

Coverage Status

Coverage remained the same at 77.778% when pulling 54968b9 on gmile:revise-docs-for-account into 782e505 on robconery:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 77.778% when pulling 64e4b21 on gmile:revise-docs-for-account into 782e505 on robconery:master.

@gmile gmile merged commit af29ee4 into beam-community:master Aug 18, 2016
@gmile gmile deleted the revise-docs-for-account branch August 18, 2016 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants