Fix doc-strings and github3.login

sigmavirus24 · sigmavirus24 · commit 4d95713ca88f · 2014-01-11T15:08:10.000-06:00
diff --git a/github3/api.py b/github3/api.py
@@ -34,7 +34,8 @@ def authorize(login, password, scopes, note='', note_url='', client_id='',
                         client_secret)
 
 
-def login(username=None, password=None, token=None, url=None):
+def login(username=None, password=None, token=None, url=None,
+          two_factor_callback=None):
     """Construct and return an authenticated GitHub session.
 
     This will return a GitHubEnterprise session if a url is provided.
@@ -43,14 +44,16 @@ def login(username=None, password=None, token=None, url=None):
     :param str password: password for the login
     :param str token: OAuth token
     :param str url: (optional), URL of a GitHub Enterprise instance
+    :param func two_factor_callback: (optional), function you implement to
+        provide the Two Factor Authentication code to GitHub when necessary
     :returns: :class:`GitHub <github3.github.GitHub>`
 
     """
     g = None
 
     if (username and password) or token:
         g = GitHubEnterprise(url) if url is not None else GitHub()
-        g.login(username, password, token)
+        g.login(username, password, token, two_factor_callback)
 
     return g
 
diff --git a/github3/github.py b/github3/github.py
@@ -857,9 +857,11 @@ def login(self, username=None, password=None, token=None,
               two_factor_callback=None):
         """Logs the user into GitHub for protected API calls.
 
-        :param str username: (optional)
-        :param str password: (optional)
-        :param str token: (optional)
+        :param str username: login name
+        :param str password: password for the login
+        :param str token: OAuth token
+        :param func two_factor_callback: (optional), function you implement to
+            provide the Two Factor Authentication code to GitHub when necessary
         """
         if username and password:
             self._session.basic_auth(username, password)
