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

Document improvements for documents in `docs/basic` #103

Merged
merged 3 commits into from Jan 24, 2019

Conversation

Projects
None yet
2 participants
@soasme
Copy link
Contributor

soasme commented Jan 24, 2019

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Other, please describe: document improvements

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

  • You consent that the copyright of your pull request source code belongs to Authlib's author.

Below are some grammar errors.

  • and etc is a wrong usage. https://www.grammarly.com/blog/et-cetera-etc/

    Et cetera is a Latin phrase. Et means “and.” Cetera means “the rest.”

  • Both of "introduction of" and "introduction to" are grammatical, but not "introduction on".
  • The benefits are obvious, it won't break things. - The right way to join two sentences is by using either A is b. C is d or A is b; c is d, the latter of which is as a complement.
  • Since it is build should be Since it is built.
  • When a user want should be When a user wants.
  • with a limited scopes. should be with limited scopes.

The first step to using any software package is getting it properly installed. seems odd to me. I assume your intention was to stress the importance of installing package for any package, including authlib. By adding a liaison just like, it's getting more readable.

@lepture lepture merged commit dee7f00 into lepture:master Jan 24, 2019

3 checks passed

codeclimate All good!
Details
codecov/project 90.88% (target 80%)
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment