Update usage of login in github3.api

sigmavirus24 · sigmavirus24 · commit ca2b08f73319 · 2014-08-22T12:49:22.000-05:00
diff --git a/LATEST_VERSION_NOTES.rst b/LATEST_VERSION_NOTES.rst
@@ -233,6 +233,9 @@ Old name                            New attribute name
 - Most instances of ``login`` as a parameter have been changed to ``username``
   for clarity and consistency. This affects the following methods:
 
+    - ``github3.authorize``
+    - ``github3.repositories_by``
+    - ``github3.user``
     - ``Organization#add_member``
     - ``Organization#is_member``
     - ``Organization#is_public_member``
diff --git a/github3/api.py b/github3/api.py
@@ -13,11 +13,11 @@
 gh = GitHub()
 
 
-def authorize(login, password, scopes, note='', note_url='', client_id='',
+def authorize(username, password, scopes, note='', note_url='', client_id='',
               client_secret='', two_factor_callback=None):
     """Obtain an authorization token for the GitHub API.
 
-    :param str login: (required)
+    :param str username: (required)
     :param str password: (required)
     :param list scopes: (required), areas you want this token to apply to,
         i.e., 'gist', 'user'
@@ -34,7 +34,7 @@ def authorize(login, password, scopes, note='', note_url='', client_id='',
     """
     gh = GitHub()
     gh.login(two_factor_callback=two_factor_callback)
-    return gh.authorize(login, password, scopes, note, note_url, client_id,
+    return gh.authorize(username, password, scopes, note, note_url, client_id,
                         client_secret)
 
 
@@ -289,15 +289,15 @@ def organizations_with(username, number=-1, etag=None):
     return gh.organizations_with(username, number, etag)
 
 
-def repositories_by(login, type=None, sort=None, direction=None, number=-1,
+def repositories_by(username, type=None, sort=None, direction=None, number=-1,
                     etag=None):
-    """List public repositories for the specified ``login``.
+    """List public repositories for the specified ``username``.
 
     .. versionadded:: 0.6
 
     .. note:: This replaces github3.iter_repos
 
-    :param str login: (required)
+    :param str username: (required)
     :param str type: (optional), accepted values:
         ('all', 'owner', 'member')
         API default: 'all'
@@ -316,7 +316,8 @@ def repositories_by(login, type=None, sort=None, direction=None, number=-1,
 
     """
     if login:
-        return gh.repositories_by(login, type, sort, direction, number, etag)
+        return gh.repositories_by(username, type, sort, direction, number,
+                                  etag)
     return iter([])
 
 
@@ -633,8 +634,8 @@ def search_users(query, sort=None, order=None, per_page=None,
                            etag)
 
 
-def user(login):
-    return gh.user(login)
+def user(username):
+    return gh.user(username)
 user.__doc__ = gh.user.__doc__
 
 
