jupyterhub / oauthenticator

OAuth + JupyterHub Authenticator = OAuthenticator
https://oauthenticator.readthedocs.io
BSD 3-Clause "New" or "Revised" License
413 stars 365 forks source link

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

Open consideRatio opened 1 year ago

consideRatio commented 1 year ago

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 commented 2 months ago

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