From 2977823a1324701d6aa7112d431be87b0e4d9a9b Mon Sep 17 00:00:00 2001 From: Bastien Wermeille Date: Thu, 13 Jul 2023 10:46:45 +0200 Subject: [PATCH] Improve code documentation --- jupyterhub/auth.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/jupyterhub/auth.py b/jupyterhub/auth.py index 3e2b117d..194d45e9 100644 --- a/jupyterhub/auth.py +++ b/jupyterhub/auth.py @@ -485,6 +485,8 @@ class Authenticator(LoggingConfigurable): - `authenticate` turns formdata into a username - `normalize_username` normalizes the username - `check_allowed` checks against the allowed usernames + - `check_blocked_users` check against the blocked usernames + - `is_admin` check if a user is an admin .. versionchanged:: 0.8 return dict instead of username @@ -603,8 +605,7 @@ class Authenticator(LoggingConfigurable): The Authenticator may return a dict instead, which MUST have a key `name` holding the username, and MAY have additional keys: - - `auth_state`, a dictionary of of auth state that will be - persisted; + - `auth_state`, a dictionary of auth state that will be persisted; - `admin`, the admin setting value for the user - `groups`, the list of group names the user should be a member of, if Authenticator.manage_groups is True.