8000 Fix docs · n1k0/github3.py@76dcc6c · GitHub
[go: up one dir, main page]
Skip to content

Commit 76dcc6c

Browse files
sigmavirus24sigmavirus24
committed
Fix docs
1 parent a811e1a commit 76dcc6c

File tree

2 files changed

+67
-5
lines changed

2 files changed

+67
-5
lines changed

‎docs/api.rst

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ Or you can simply use the following functions
3737

3838
------
3939

40+
.. autofunction:: github3.authorize
41+
42+
------
43+
4044
.. autofunction:: github3.create_gist
4145

4246
------
@@ -49,18 +53,66 @@ Or you can simply use the following functions
4953

5054
------
5155

52-
.. autofunction:: github3.list_events
56+
.. autofunction:: github3.iter_events
57+
58+
------
59+
60+
.. autofunction:: github3.iter_followers
61+
62+
------
63+
64+
.. autofunction:: github3.iter_following
65+
66+
------
67+
68+
.. autofunction:: github3.iter_gists
69+
70+
------
71+
72+
.. autofunction:: github3.iter_orgs
73+
74+
------
75+
76+
.. autofunction:: github3.iter_repos
77+
78+
------
79+
80+
.. autofunction:: github3.iter_repo_issues
5381

5482
------
5583

56-
.. autofunction:: github3.list_gists
84+
.. autofunction:: github3.iter_starred
85+
86+
------
87+
88+
.. autofunction:: github3.iter_subscriptions
5789

5890
------
5991

6092
.. autofunction:: github3.markdown
6193

6294
------
6395

96+
.. autofunction:: github3.octocat
97+
98+
------
99+
100+
.. autofunction:: github3.organization
101+
102+
------
103+
104+
.. autofunction:: github3.pull_request
105+
106+
------
107+
108+
.. autofunction:: github3.ratelimit_remaining
109+
110+
------
111+
112+
.. autofunction:: github3.repository
113+
114+
------
115+
64116
.. autofunction:: github3.search_issues
65117

66118
------
@@ -81,7 +133,7 @@ Or you can simply use the following functions
81133

82134
------
83135

84-
.. autofunction:: github3.ratelimit_remaining
136+
.. autofunction:: github3.zen
85137

86138
------
87139

‎github3/api.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,17 @@
1313

1414

1515
def authorize(login, password, scopes, note='', note_url=''):
16-
"""See :func:`authorize <github3.github.GitHub.authorize>`"""
16+
"""Obtain an authorization token from the GitHub API for the GitHub
17+
API.
18+
19+
:param str login: (required)
20+
:param str password: (required)
21+
:param list scopes: (required), areas you want this token to apply to,
22+
i.e., 'gist', 'user'
23+
:param str note: (optional), note about the authorization
24+
:param str note_url: (optional), url for the application
25+
:returns: :class:`Authorization <Authorization>`
26+
"""
1727
return gh.authorize(login, password, scopes, note, note_url)
1828

1929

@@ -113,7 +123,7 @@ def iter_repo_issues(owner, repository, filter='', state='', labels='',
113123
"""
114124
if owner and repository:
115125
return gh.iter_repo_issues(owner, repository, filter, state, labels,
116-
sort, direction, since, number)
126+
sort, direction, since, number)
117127
return iter([])
118128

119129

0 commit comments

Comments
 (0)
0