From 175b000c888c1efd81bb3962b060be8c70504ba9 Mon Sep 17 00:00:00 2001 From: Yuvi Panda Date: Tue, 7 May 2024 10:46:33 -0700 Subject: [PATCH] Clarify docs Co-authored-by: Simon Li --- oauthenticator/oauth2.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/oauthenticator/oauth2.py b/oauthenticator/oauth2.py index 750a693d..ba795817 100644 --- a/oauthenticator/oauth2.py +++ b/oauthenticator/oauth2.py @@ -1047,8 +1047,7 @@ def get_user_groups(self, auth_state: dict): Returns a set of groups the user belongs to based on auth_state_groups_key and provided auth_state. - - If auth_state_groups_key is a callable, it is meant to return the groups - directly. + - If auth_state_groups_key is a callable, it returns the list of groups directly. - If auth_state_groups_key is a nested dictionary key like "permissions.groups", this function returns auth_state["permissions"]["groups"].