Skip to content

Commit 8041939

Browse files
authored
docs: Fix a few typos (#1183)
There are small typos in: - docs/advanced_topics.rst - docs/contributing.rst - docs/oidc.rst - docs/rest-framework/permissions.rst - docs/templates.rst - oauth2_provider/management/commands/createapplication.py - tests/test_authorization_code.py Fixes: - Should read `successful` rather than `successfull`. - Should read `unneeded` rather than `unneded`. - Should read `programmatically` rather than `programmaticaly`. - Should read `overriding` rather than `overiding`. - Should read `contributors` rather than `contrbutors`. - Should read `browsable` rather than `browseable`. - Should read `additional` rather than `addtional`.
1 parent 691b6b2 commit 8041939

File tree

7 files changed

+9
-9
lines changed

7 files changed

+9
-9
lines changed

docs/advanced_topics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,5 +97,5 @@ Skip authorization completely for trusted applications
9797

9898
You might want to completely bypass the authorization form, for instance if your application is an
9999
in-house product or if you already trust the application owner by other means. To this end, you have to
100-
set ``skip_authorization = True`` on the ``Application`` model, either programmaticaly or within the
100+
set ``skip_authorization = True`` on the ``Application`` model, either programmatically or within the
101101
Django admin. Users will *not* be prompted for authorization, even on the first use of the application.

docs/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ When you begin your PR, you'll be asked to provide the following:
167167
JazzBand security team `<[email protected]>`. Do not file an issue on the tracker
168168
or submit a PR until directed to do so.)
169169

170-
* Make sure your name is in `AUTHORS`. We want to give credit to all contrbutors!
170+
* Make sure your name is in `AUTHORS`. We want to give credit to all contributors!
171171

172172
If your PR is not yet ready to be merged mark it as a Work-in-Progress
173173
By prepending `WIP:` to the PR title so that it doesn't get inadvertently approved and merged.

docs/oidc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ The following example adds instructions to return the ``foo`` claim when the ``b
317317

318318
Set ``oidc_claim_scope = None`` to return all claims irrespective of the granted scopes.
319319

320-
You have to make sure you've added addtional claims via ``get_additional_claims``
320+
You have to make sure you've added additional claims via ``get_additional_claims``
321321
and defined the ``OAUTH2_PROVIDER["SCOPES"]`` in your settings in order for this functionality to work.
322322

323323
.. note::

docs/rest-framework/permissions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ IsAuthenticatedOrTokenHasScope
7070
------------------------------
7171
The `IsAuthenticatedOrTokenHasScope` permission class allows access only when the current access token has been authorized for **all** the scopes listed in the `required_scopes` field of the view but according to the request's method.
7272
It also allows access to Authenticated users who are authenticated in django, but were not authenticated through the OAuth2Authentication class.
73-
This allows for protection of the API using scopes, but still let's users browse the full browseable API.
74-
To restrict users to only browse the parts of the browseable API they should be allowed to see, you can combine this with the DjangoModelPermission or the DjangoObjectPermission.
73+
This allows for protection of the API using scopes, but still let's users browse the full browsable API.
74+
To restrict users to only browse the parts of the browsable API they should be allowed to see, you can combine this with the DjangoModelPermission or the DjangoObjectPermission.
7575

7676
For example:
7777

docs/templates.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ This template gets passed the following template context variables:
168168

169169
.. caution::
170170
In the default implementation this template in extended by `application_registration_form.html`_.
171-
Be sure to provide the same blocks if you are only overiding this template.
171+
Be sure to provide the same blocks if you are only overriding this template.
172172

173173
application_registration_form.html
174174
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

oauth2_provider/management/commands/createapplication.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def handle(self, *args, **options):
6565
application_fields = [field.name for field in Application._meta.fields]
6666
application_data = {}
6767
for key, value in options.items():
68-
# Data in options must be cleaned because there are unneded key-value like
68+
# Data in options must be cleaned because there are unneeded key-value like
6969
# verbosity and others. Also do not pass any None to the Application
7070
# instance so default values will be generated for those fields
7171
if key in application_fields and value:

tests/test_authorization_code.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1145,7 +1145,7 @@ def test_public(self):
11451145
def test_public_pkce_S256_authorize_get(self):
11461146
"""
11471147
Request an access token using client_type: public
1148-
and PKCE enabled. Tests if the authorize get is successfull
1148+
and PKCE enabled. Tests if the authorize get is successful
11491149
for the S256 algorithm and form data are properly passed.
11501150
"""
11511151
self.client.login(username="test_user", password="123456")
@@ -1172,7 +1172,7 @@ def test_public_pkce_S256_authorize_get(self):
11721172
def test_public_pkce_plain_authorize_get(self):
11731173
"""
11741174
Request an access token using client_type: public
1175-
and PKCE enabled. Tests if the authorize get is successfull
1175+
and PKCE enabled. Tests if the authorize get is successful
11761176
for the plain algorithm and form data are properly passed.
11771177
"""
11781178
self.client.login(username="test_user", password="123456")

0 commit comments

Comments
 (0)