From 3774ec283e096d5fb630d707302df44f32f5634f Mon Sep 17 00:00:00 2001 From: Nejc Habjan Date: Fri, 8 Oct 2021 19:36:25 +0200 Subject: [PATCH] chore(docs): clarify token type usage with auth() --- docs/api-usage.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api-usage.rst b/docs/api-usage.rst index 8bf935375..f30ed0351 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -38,7 +38,8 @@ To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab`` gl = gitlab.Gitlab('https://gitlab.example.com', user_agent='my-package/1.0.0') # make an API request to create the gl.user object. This is mandatory if you - # use the username/password authentication (not required for job token authentication). + # use the username/password authentication - not required for token authentication, + # and will not work with job tokens. gl.auth() You can also use configuration files to create ``gitlab.Gitlab`` objects: