Skip to content

Commit d36dc38

Browse files
authored
Fixed typos and grammatical errors in the flask_client docs.
1 parent 639ca66 commit d36dc38

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/client/flask.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Configuration
4444
-------------
4545

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

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

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

9090
Our ``OAuth`` registry provides a simple way to store temporary credentials in a cache
@@ -128,7 +128,7 @@ Accessing OAuth Resources
128128
-------------------------
129129

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

134134
from flask import render_template
@@ -156,7 +156,7 @@ In this case, our ``fetch_token`` could look like::
156156
)
157157
return token.to_token()
158158

159-
# initialize OAuth registry with this fetch_token function
159+
# initialize the OAuth registry with this fetch_token function
160160
oauth = OAuth(fetch_token=fetch_token)
161161

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

170170
The signal is added since v0.13
171171

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

175-
Before using signal, make sure you have installed **blinker** library::
175+
Before using the signal, make sure you have installed the **blinker** library::
176176

177177
$ pip install blinker
178178

@@ -200,7 +200,7 @@ Flask OpenID Connect Client
200200
---------------------------
201201

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

206206
oauth.register(

0 commit comments

Comments
 (0)