Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add explanation section on how subclasses override functions called from the non-overridden authenticate function #634

Open
consideRatio opened this issue Jul 3, 2023 · 1 comment

Comments

@consideRatio
Copy link
Member

The OAuthenticator.authenticate function is not supposed to be overridden, instead the subclasses are to override functions introduced in this project and called from the OAuthenticator.authenticate and check_allowed which is introduced in the Authenticator and overridden by OAuthenticator, and supposed to be overridden again by subclasses.

This section would be relevant to have if writing a tutorial on how to write a custom authenticator.

@kellyrowland
Copy link

+1, this would be really useful to have explained in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants