Skip to content

Commit

Permalink
docs: Fix a few typos (#1183)
Browse files Browse the repository at this point in the history
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`.
  • Loading branch information
timgates42 committed Jul 5, 2022
1 parent 691b6b2 commit 8041939
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/advanced_topics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,5 +97,5 @@ Skip authorization completely for trusted applications

You might want to completely bypass the authorization form, for instance if your application is an
in-house product or if you already trust the application owner by other means. To this end, you have to
set ``skip_authorization = True`` on the ``Application`` model, either programmaticaly or within the
set ``skip_authorization = True`` on the ``Application`` model, either programmatically or within the
Django admin. Users will *not* be prompted for authorization, even on the first use of the application.
2 changes: 1 addition & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ When you begin your PR, you'll be asked to provide the following:
JazzBand security team `<security@jazzband.co>`. Do not file an issue on the tracker
or submit a PR until directed to do so.)

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

If your PR is not yet ready to be merged mark it as a Work-in-Progress
By prepending `WIP:` to the PR title so that it doesn't get inadvertently approved and merged.
Expand Down
2 changes: 1 addition & 1 deletion docs/oidc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ The following example adds instructions to return the ``foo`` claim when the ``b

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

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

.. note::
Expand Down
4 changes: 2 additions & 2 deletions docs/rest-framework/permissions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ IsAuthenticatedOrTokenHasScope
------------------------------
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.
It also allows access to Authenticated users who are authenticated in django, but were not authenticated through the OAuth2Authentication class.
This allows for protection of the API using scopes, but still let's users browse the full browseable API.
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.
This allows for protection of the API using scopes, but still let's users browse the full browsable API.
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.

For example:

Expand Down
2 changes: 1 addition & 1 deletion docs/templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ This template gets passed the following template context variables:

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

application_registration_form.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion oauth2_provider/management/commands/createapplication.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def handle(self, *args, **options):
application_fields = [field.name for field in Application._meta.fields]
application_data = {}
for key, value in options.items():
# Data in options must be cleaned because there are unneded key-value like
# Data in options must be cleaned because there are unneeded key-value like
# verbosity and others. Also do not pass any None to the Application
# instance so default values will be generated for those fields
if key in application_fields and value:
Expand Down
4 changes: 2 additions & 2 deletions tests/test_authorization_code.py
Original file line number Diff line number Diff line change
Expand Up @@ -1145,7 +1145,7 @@ def test_public(self):
def test_public_pkce_S256_authorize_get(self):
"""
Request an access token using client_type: public
and PKCE enabled. Tests if the authorize get is successfull
and PKCE enabled. Tests if the authorize get is successful
for the S256 algorithm and form data are properly passed.
"""
self.client.login(username="test_user", password="123456")
Expand All @@ -1172,7 +1172,7 @@ def test_public_pkce_S256_authorize_get(self):
def test_public_pkce_plain_authorize_get(self):
"""
Request an access token using client_type: public
and PKCE enabled. Tests if the authorize get is successfull
and PKCE enabled. Tests if the authorize get is successful
for the plain algorithm and form data are properly passed.
"""
self.client.login(username="test_user", password="123456")
Expand Down

0 comments on commit 8041939

Please sign in to comment.