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

Fixed typos and grammatical errors in the flask_client docs. #691

Merged
merged 1 commit into from
Dec 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/client/flask.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Configuration
-------------

Authlib Flask OAuth registry can load the configuration from Flask ``app.config``
automatically. Every key value pair in ``.register`` can be omitted. They can be
automatically. Every key-value pair in ``.register`` can be omitted. They can be
configured in your Flask App configuration. Config keys are formatted as
``{name}_{key}`` in uppercase, e.g.

Expand All @@ -71,7 +71,7 @@ Here is a full list of the configuration keys:
- ``{name}_REQUEST_TOKEN_PARAMS``: Extra parameters for Request Token endpoint
- ``{name}_ACCESS_TOKEN_URL``: Access Token endpoint for OAuth 1 and OAuth 2
- ``{name}_ACCESS_TOKEN_PARAMS``: Extra parameters for Access Token endpoint
- ``{name}_AUTHORIZE_URL``: Endpoint for user authorization of OAuth 1 ro OAuth 2
- ``{name}_AUTHORIZE_URL``: Endpoint for user authorization of OAuth 1 or OAuth 2
- ``{name}_AUTHORIZE_PARAMS``: Extra parameters for Authorization Endpoint.
- ``{name}_API_BASE_URL``: A base URL endpoint to make requests simple
- ``{name}_CLIENT_KWARGS``: Extra keyword arguments for OAuth1Session or OAuth2Session
Expand All @@ -83,8 +83,8 @@ your Flask application configuration.
Using Cache for Temporary Credential
------------------------------------

By default, Flask OAuth registry will use Flask session to store OAuth 1.0 temporary
credential (request token). However in this way, there are chances your temporary
By default, the Flask OAuth registry will use Flask session to store OAuth 1.0 temporary
credential (request token). However, in this way, there are chances your temporary
credential will be exposed.

Our ``OAuth`` registry provides a simple way to store temporary credentials in a cache
Expand Down Expand Up @@ -128,7 +128,7 @@ Accessing OAuth Resources
-------------------------

There is no ``request`` in accessing OAuth resources either. Just like above,
we don't need to pass ``request`` parameter, everything is handled by Authlib
we don't need to pass the ``request`` parameter, everything is handled by Authlib
automatically::

from flask import render_template
Expand Down Expand Up @@ -156,7 +156,7 @@ In this case, our ``fetch_token`` could look like::
)
return token.to_token()

# initialize OAuth registry with this fetch_token function
# initialize the OAuth registry with this fetch_token function
oauth = OAuth(fetch_token=fetch_token)

You don't have to pass ``token``, you don't have to pass ``request``. That
Expand All @@ -169,10 +169,10 @@ Auto Update Token via Signal

The signal is added since v0.13

Instead of define a ``update_token`` method and passing it into OAuth registry,
it is also possible to use signal to listen for token updating.
Instead of defining an ``update_token`` method and passing it into the OAuth registry,
it is also possible to use a signal to listen for token updating.

Before using signal, make sure you have installed **blinker** library::
Before using the signal, make sure you have installed the **blinker** library::

$ pip install blinker

Expand Down Expand Up @@ -200,7 +200,7 @@ Flask OpenID Connect Client
---------------------------

An OpenID Connect client is no different than a normal OAuth 2.0 client. When
register with ``openid`` scope, the built-in Flask OAuth client will handle everything
registered with ``openid`` scope, the built-in Flask OAuth client will handle everything
automatically::

oauth.register(
Expand Down