Ian Cordasco avatar Ian Cordasco committed 76dcc6c

Fix docs

Comments (0)

Files changed (2)

 
 ------
 
+.. autofunction:: github3.authorize
+
+------
+
 .. autofunction:: github3.create_gist
 
 ------
 
 ------
 
-.. autofunction:: github3.list_events
+.. autofunction:: github3.iter_events
+
+------
+
+.. autofunction:: github3.iter_followers
+
+------
+
+.. autofunction:: github3.iter_following
+
+------
+
+.. autofunction:: github3.iter_gists
+
+------
+
+.. autofunction:: github3.iter_orgs
+
+------
+
+.. autofunction:: github3.iter_repos
+
+------
+
+.. autofunction:: github3.iter_repo_issues
 
 ------
 
-.. autofunction:: github3.list_gists
+.. autofunction:: github3.iter_starred
+
+------
+
+.. autofunction:: github3.iter_subscriptions
 
 ------
 
 
 ------
 
+.. autofunction:: github3.octocat
+
+------
+
+.. autofunction:: github3.organization
+
+------
+
+.. autofunction:: github3.pull_request
+
+------
+
+.. autofunction:: github3.ratelimit_remaining
+
+------
+
+.. autofunction:: github3.repository
+
+------
+
 .. autofunction:: github3.search_issues
 
 ------
 
 ------
 
-.. autofunction:: github3.ratelimit_remaining
+.. autofunction:: github3.zen
 
 ------
 
 
 
 def authorize(login, password, scopes, note='', note_url=''):
-    """See :func:`authorize <github3.github.GitHub.authorize>`"""
+    """Obtain an authorization token from the GitHub API for the GitHub
+    API.
+
+    :param str login: (required)
+    :param str password: (required)
+    :param list scopes: (required), areas you want this token to apply to,
+        i.e., 'gist', 'user'
+    :param str note: (optional), note about the authorization
+    :param str note_url: (optional), url for the application
+    :returns: :class:`Authorization <Authorization>`
+    """
     return gh.authorize(login, password, scopes, note, note_url)
 
 
     """
     if owner and repository:
         return gh.iter_repo_issues(owner, repository, filter, state, labels,
-                                     sort, direction, since, number)
+                                   sort, direction, since, number)
     return iter([])
 
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.