Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Simon Li <[email protected]>
  • Loading branch information
consideRatio and manics authored Jul 4, 2023
1 parent 8c801d9 commit b3f66a7
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -231,5 +231,4 @@ def setup(app):
# 2023-06-29 docs refresh
"topic/cilogon": "tutorials/provider-specific-setup/providers/cilogon",
"tutorials/provider-specific-setup/providers/awscognito": "tutorials/provider-specific-setup/providers/generic",
"how-to/migrations/upgrade-to-16": "reference/changelog",
}
8 changes: 4 additions & 4 deletions docs/source/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ command line for details.
and `shown_idps`, `username_claim`, `additional_username_claims` must no
longer be configured.
- [Okpy] The public functions `OkpyOAuthenticator.get_auth_request` and
`OkpyOAuthenticator.get_user_info_request` was removed.
`OkpyOAuthenticator.get_user_info_request` were removed.

### Deprecations

- [Generic, Auth0] `username_key` is deprecated and is being replaced by
- [Generic, Auth0] `username_key` is deprecated and is replaced by
{attr}`.OAuthenticator.username_claim`.
- [Generic] {attr}`.GenericOAuthenticator.extra_params` is deprecated and is
being replaced by {attr}`.OAuthenticator.token_params`.
replaced by {attr}`.OAuthenticator.token_params`.

### Highlights

Expand All @@ -50,7 +50,7 @@ command line for details.
- [All] {attr}`.OAuthenticator.refresh_pre_spawn` is now by default enabled if
{attr}`.OAuthenticator.enable_auth_state` is enabled.

- [All] Low level configurations in `GenericOAuthenticator` has been moved to
- [All] Low level configuration in `GenericOAuthenticator` has been moved to
the common base class `OAuthenticator` and is therefore available to all
authenticators.

Expand Down
6 changes: 3 additions & 3 deletions oauthenticator/oauth2.py
Original file line number Diff line number Diff line change
Expand Up @@ -303,8 +303,8 @@ class OAuthenticator(Authenticator):
config=True,
help="""
The URL to where the user is to be redirected initially based on the
OAuth2 protocol. The user is supposed to be redirected back with a
`authorization grant code`_ after interacting successfully with the
OAuth2 protocol. The user will be redirected back with an
`authorization grant code`_ after authenticating successfully with the
identity provider.
.. _authorization grant code: https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1
Expand Down Expand Up @@ -527,7 +527,7 @@ def _validate_server_cert_default(self):
# Example: validate against certain root certificates
c.OAuthenticator.http_request_kwargs = {
"ca_certs": "/run/secrets/kubernetes.io/serviceaccount/ca.crt",
"ca_certs": "/path/to/a.crt",
}
See :external:py:class:`tornado.httpclient.HTTPRequest` for all kwargs
Expand Down

0 comments on commit b3f66a7

Please sign in to comment.