Merge pull request #1000 from matusf/update-auth-docs

max-wittig · web-flow · commit 7843ace91358 · 2020-01-26T21:19:35.000+01:00
Update auth docs
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -23,9 +23,6 @@ To connect to a GitLab server, create a ``gitlab.Gitlab`` object:
    import os
    gl = gitlab.Gitlab('http://10.0.0.1', job_token=os.environ['CI_JOB_TOKEN'])
 
-   # username/password authentication (for GitLab << 10.2)
-   gl = gitlab.Gitlab('http://10.0.0.1', email='jdoe', password='s3cr3t')
-
    # anonymous gitlab instance, read-only for public resources
    gl = gitlab.Gitlab('http://10.0.0.1')
 
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -60,8 +60,6 @@ class Gitlab(object):
         private_token (str): The user private token
         oauth_token (str): An oauth token
         job_token (str): A CI job token
-        email (str): The user email or login.
-        password (str): The user password (associated with email).
         ssl_verify (bool|str): Whether SSL certificates should be validated. If
             the value is a string, it is the path to a CA file used for
             certificate validation.
@@ -211,9 +209,7 @@ def from_config(cls, gitlab_id=None, config_files=None):
         )
 
     def auth(self):
-        """Performs an authentication.
-
-        Uses either the private token, or the email/password pair.
+        """Performs an authentication using private token.
 
         The `user` attribute will hold a `gitlab.objects.CurrentUser` object on
         success.
