Skip to content

Commit

Permalink
docs: Fix a few typos
Browse files Browse the repository at this point in the history
There are small typos in:
- docs/oauth1/security.rst
- docs/oauth2/grants/custom_grant.rst
- oauthlib/oauth2/rfc6749/clients/backend_application.py
- oauthlib/oauth2/rfc6749/clients/base.py
- oauthlib/oauth2/rfc6749/clients/legacy_application.py
- oauthlib/oauth2/rfc6749/clients/service_application.py
- oauthlib/oauth2/rfc6749/clients/web_application.py
- oauthlib/oauth2/rfc6749/endpoints/revocation.py
- oauthlib/oauth2/rfc6749/parameters.py
- oauthlib/openid/connect/core/grant_types/dispatchers.py

Fixes:
- Should read `parameters` rather than `paramters`.
- Should read `instantiate` rather than `instanciate`.
- Should read `successfully` rather than `sucessfully`.
- Should read `present` rather than `pressent`.
- Should read `parameter` rather than `paramater`.
- Should read `efficient` rather than `effecient`.
  • Loading branch information
timgates42 authored and auvipy committed Jul 3, 2022
1 parent bdc486e commit 6569ec3
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/oauth1/security.rst
Expand Up @@ -20,7 +20,7 @@ A few important facts regarding OAuth security
for Python 3.6 and later. The ``secrets`` module is designed for
generating cryptographically strong random numbers. For earlier versions
of Python, use ``random.SystemRandom`` which is based on ``os.urandom``
rather than the default ``random`` based on the effecient but not truly
rather than the default ``random`` based on the efficient but not truly
random Mersenne Twister. Predictable tokens allow attackers to bypass
virtually all defences OAuth provides.

Expand Down
4 changes: 2 additions & 2 deletions docs/oauth2/grants/custom_grant.rst
Expand Up @@ -37,7 +37,7 @@ existing ones.

3. Associate it with Endpoints
------------------------------
Then, once implemented, you have to instanciate the grant object and
Then, once implemented, you have to instantiate the grant object and
bind it to your endpoint. Either :py:class:`AuthorizationEndpoint`,
:py:class:`TokenEndpoint` or both.

Expand All @@ -48,7 +48,7 @@ This example shows how to add a simple extension to the `Token endpoint`:
* creation of a new class ``MyCustomGrant``, and implement ``create_token_response``.
* do basics and custom request validations, then call a custom method
of `Request Validator` to extend the interface for the implementor.
* instanciate the new grant, and bind it with an existing ``Server``.
* instantiate the new grant, and bind it with an existing ``Server``.

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion oauthlib/oauth2/rfc6749/clients/backend_application.py
Expand Up @@ -39,7 +39,7 @@ def prepare_request_body(self, body='', scope=None,
format per `Appendix B`_ in the HTTP request entity-body:
:param body: Existing request body (URL encoded string) to embed parameters
into. This may contain extra paramters. Default ''.
into. This may contain extra parameters. Default ''.
:param scope: The scope of the access request as described by
`Section 3.3`_.
Expand Down
4 changes: 2 additions & 2 deletions oauthlib/oauth2/rfc6749/clients/base.py
Expand Up @@ -274,7 +274,7 @@ def prepare_token_request(self, token_url, authorization_response=None,
request (if there was one).
:param state:
:param body: Existing request body (URL encoded string) to embed parameters
into. This may contain extra paramters. Default ''.
into. This may contain extra parameters. Default ''.
:param kwargs: Additional parameters to included in the request.
:returns: The prepared request tuple with (url, headers, body).
"""
Expand Down Expand Up @@ -303,7 +303,7 @@ def prepare_refresh_token_request(self, token_url, refresh_token=None,
:param token_url: Provider token refresh endpoint URL.
:param refresh_token: Refresh token string.
:param body: Existing request body (URL encoded string) to embed parameters
into. This may contain extra paramters. Default ''.
into. This may contain extra parameters. Default ''.
:param scope: List of scopes to request. Must be equal to
or a subset of the scopes granted when obtaining the refresh
token. If none is provided, the ones provided in the constructor are
Expand Down
2 changes: 1 addition & 1 deletion oauthlib/oauth2/rfc6749/clients/legacy_application.py
Expand Up @@ -49,7 +49,7 @@ def prepare_request_body(self, username, password, body='', scope=None,
:param username: The resource owner username.
:param password: The resource owner password.
:param body: Existing request body (URL encoded string) to embed parameters
into. This may contain extra paramters. Default ''.
into. This may contain extra parameters. Default ''.
:param scope: The scope of the access request as described by
`Section 3.3`_.
:param include_client_id: `True` to send the `client_id` in the
Expand Down
2 changes: 1 addition & 1 deletion oauthlib/oauth2/rfc6749/clients/service_application.py
Expand Up @@ -99,7 +99,7 @@ def prepare_request_body(self,
:param extra_claims: A dict of additional claims to include in the JWT.
:param body: Existing request body (URL encoded string) to embed parameters
into. This may contain extra paramters. Default ''.
into. This may contain extra parameters. Default ''.
:param scope: The scope of the access request.
Expand Down
2 changes: 1 addition & 1 deletion oauthlib/oauth2/rfc6749/clients/web_application.py
Expand Up @@ -117,7 +117,7 @@ def prepare_request_body(self, code=None, redirect_uri=None, body='',
values MUST be identical.
:param body: Existing request body (URL encoded string) to embed parameters
into. This may contain extra paramters. Default ''.
into. This may contain extra parameters. Default ''.
:param include_client_id: `True` (default) to send the `client_id` in the
body of the upstream request. This is required
Expand Down
2 changes: 1 addition & 1 deletion oauthlib/oauth2/rfc6749/endpoints/revocation.py
Expand Up @@ -42,7 +42,7 @@ def create_revocation_response(self, uri, http_method='POST', body=None,
The authorization server responds with HTTP status code 200 if the
token has been revoked sucessfully or if the client submitted an
token has been revoked successfully or if the client submitted an
invalid token.
Note: invalid tokens do not cause an error response since the client
Expand Down
2 changes: 1 addition & 1 deletion oauthlib/oauth2/rfc6749/parameters.py
Expand Up @@ -45,7 +45,7 @@ def prepare_grant_uri(uri, client_id, response_type, redirect_uri=None,
back to the client. The parameter SHOULD be used for
preventing cross-site request forgery as described in
`Section 10.12`_.
:param code_challenge: PKCE paramater. A challenge derived from the
:param code_challenge: PKCE parameter. A challenge derived from the
code_verifier that is sent in the authorization
request, to be verified against later.
:param code_challenge_method: PKCE parameter. A method that was used to derive the
Expand Down
2 changes: 1 addition & 1 deletion oauthlib/openid/connect/core/grant_types/dispatchers.py
Expand Up @@ -84,7 +84,7 @@ def _handler_for_request(self, request):
code = parameters.get('code', None)
redirect_uri = parameters.get('redirect_uri', None)

# If code is not pressent fallback to `default_grant` which will
# If code is not present fallback to `default_grant` which will
# raise an error for the missing `code` in `create_token_response` step.
if code:
scopes = self.request_validator.get_authorization_code_scopes(client_id, code, redirect_uri, request)
Expand Down

0 comments on commit 6569ec3

Please sign in to comment.