diff --git a/src/Config/AuthGroups.php b/src/Config/AuthGroups.php index 95309f1b0..1fef9e312 100644 --- a/src/Config/AuthGroups.php +++ b/src/Config/AuthGroups.php @@ -20,10 +20,15 @@ class AuthGroups extends BaseConfig * -------------------------------------------------------------------- * Groups * -------------------------------------------------------------------- - * The available authentication systems, listed - * with alias and class name. These can be referenced - * by alias in the auth helper: - * auth('api')->attempt($credentials); + * An associative array of the available groups in the system, where the keys are + * the group names and the values are arrays of the group info. + * + * Whatever value you assign as the key will be used to refer to the group when using functions such as: + * $user->addGroup('superadmin'); + * + * @var array> + * + * @see https://github.com/codeigniter4/shield/blob/develop/docs/quickstart.md#change-available-groups for more info */ public array $groups = [ 'superadmin' => [