Skip to content

Commit

Permalink
chore(docs): clarify token type usage with auth()
Browse files Browse the repository at this point in the history
  • Loading branch information
nejch committed Oct 8, 2021
1 parent 746c25f commit 3774ec2
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/api-usage.rst
Expand Up @@ -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:
Expand Down

0 comments on commit 3774ec2

Please sign in to comment.