Skip to content

Commit 2b6f69d

Browse files
authored
Fix typos in documentation (#451)
1 parent 7cfc74a commit 2b6f69d

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

docs/add_custom_data_claims.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ decorator to register a callback function that will be called whenever a new JWT
1919
is created, and return a dictionary of claims to add to that token. In the case
2020
that both :meth:`~flask_jwt_extended.JWTManager.additional_claims_loader` and the
2121
``additional_claims`` argument are used, both results are merged together, with ties
22-
going to the data suplied by the ``additional_claims`` argument.
22+
going to the data supplied by the ``additional_claims`` argument.
2323

2424
.. code-block:: python
2525

docs/automatic_user_loading.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ Automatic User Loading
33

44
In most web applications it is important to have access to the user who is
55
accessing a protected route. We provide a couple callback functions that make
6-
this seemless while working with JWTs.
6+
this seamless while working with JWTs.
77

88
The first is :meth:`~flask_jwt_extended.JWTManager.user_identity_loader`, which
99
will convert any ``User`` object used to create a JWT into a JSON serializable format.
1010

1111
On the flip side, you can use :meth:`~flask_jwt_extended.JWTManager.user_lookup_loader`
12-
to automaticallly load your ``User`` object when a JWT is present in the request.
12+
to automatically load your ``User`` object when a JWT is present in the request.
1313
The loaded user is available in your protected routes via :attr:`~flask_jwt_extended.current_user`.
1414

1515
Lets see an example of this while utilizing SQLAlchemy to store our users:

docs/basic_usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ We can see this in action using `HTTPie <https://httpie.io/>`_.
6464
6565
**Important**
6666

67-
Remember to change the jwt secret key in your application, and ensure that it
67+
Remember to change the JWT secret key in your application, and ensure that it
6868
is secure. The JWTs are signed with this key, and if someone gets their hands
69-
on it they will be able to create arbitraty tokens that are accepted by your
69+
on it they will be able to create arbitrary tokens that are accepted by your
7070
web flask application.

docs/optional_endpoints.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Partially protecting routes
22
===========================
33

44
There may be cases where you want to use the same route regardless of if a JWT
5-
is present in the requst or not. In these situations, you can use
5+
is present in the request or not. In these situations, you can use
66
:func:`~flask_jwt_extended.jwt_required` with the ``optional=True`` argument. This
77
will allow the endpoint to be accessed regardless of if a JWT is sent in with
88
the request.
@@ -12,7 +12,7 @@ If no JWT is present, :func:`~flask_jwt_extended.get_jwt` and
1212
:func:`~flask_jwt_extended.get_jwt_identity`, :attr:`~flask_jwt_extended.current_user`,
1313
and :func:`~flask_jwt_extended.get_current_user` will return None.
1414

15-
If a JWT that is expired or not verifyable is in the request, an error will be
15+
If a JWT that is expired or not verifiable is in the request, an error will be
1616
still returned like normal.
1717

1818

docs/options.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ General Options:
2020
``["headers", "cookies"]``. The order of the list sets the precedence of
2121
where JWTs will be looked for.
2222

23-
This can be overriden on a per-route basis by using the ``locations``
23+
This can be overridden on a per-route basis by using the ``locations``
2424
argument in :func:`flask_jwt_extended.jwt_required`.
2525

2626
Default: ``"headers"``
@@ -61,15 +61,15 @@ General Options:
6161
.. py:data:: JWT_ALGORITHM
6262
6363
Which algorithm to sign the JWT with. See `PyJWT <https://pyjwt.readthedocs.io/en/latest/algorithms.html>`_
64-
for the available algorightms.
64+
for the available algorithms.
6565

6666
Default: ``"HS256"``
6767

6868

6969
.. py:data:: JWT_DECODE_ALGORITHMS
7070
7171
Which algorithms to use when decoding a JWT. See `PyJWT <https://pyjwt.readthedocs.io/en/latest/algorithms.html>`_
72-
for the available algorightms.
72+
for the available algorithms.
7373

7474
By default this will always be the same algorithm that is defined in ``JWT_ALGORITHM``.
7575

@@ -79,7 +79,7 @@ General Options:
7979
.. py:data:: JWT_SECRET_KEY
8080
8181
The secret key used to encode and decode JWTs when using a symmetric signing
82-
algorightm (such as ``HS*``). It should be a long random string of bytes,
82+
algorithm (such as ``HS*``). It should be a long random string of bytes,
8383
although unicode is accepted too. For example, copy the output of this to
8484
your config.
8585

@@ -99,7 +99,7 @@ General Options:
9999
.. py:data:: JWT_PRIVATE_KEY
100100
101101
The secret key used to encode JWTs when using an asymmetric signing
102-
algorightm (such as ``RS*`` or ``ES*``). The key must be in PEM format.
102+
algorithm (such as ``RS*`` or ``ES*``). The key must be in PEM format.
103103

104104
**Do not reveal the secret key when posting questions or committing code.**
105105

@@ -109,7 +109,7 @@ General Options:
109109
.. py:data:: JWT_PUBLIC_KEY
110110
111111
The secret key used to decode JWTs when using an asymmetric signing
112-
algorightm (such as ``RS*`` or ``ES*``). The key must be in PEM format.
112+
algorithm (such as ``RS*`` or ``ES*``). The key must be in PEM format.
113113

114114
Default: ``None``
115115

0 commit comments

Comments
 (0)