Skip to content

Commit 3774ec2

Browse files
authored
chore(docs): clarify token type usage with auth()
1 parent 746c25f commit 3774ec2

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/api-usage.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab``
3838
gl = gitlab.Gitlab('https://gitlab.example.com', user_agent='my-package/1.0.0')
3939
4040
# make an API request to create the gl.user object. This is mandatory if you
41-
# use the username/password authentication (not required for job token authentication).
41+
# use the username/password authentication - not required for token authentication,
42+
# and will not work with job tokens.
4243
gl.auth()
4344
4445
You can also use configuration files to create ``gitlab.Gitlab`` objects:

0 commit comments

Comments
 (0)