8000 list -> generator in documentation where appropriate · losingkeys/github3.py@eb88386 · GitHub
[go: up one dir, main page]
Skip to content

Commit eb88386

Browse files
fenekkufenekku
committed
list -> generator in documentation where appropriate
1 parent cc9e4aa commit eb88386

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

‎github3/repos/repo.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -877,7 +877,7 @@ def iter_assignees(self, number=-1, etag=None):
877877
-1 returns all available assignees
878878
:param str etag: (optional), ETag from a previous request to the same
879879
endpoint
880-
:returns: list of :class:`User <github3.users.User>`\ s
880+
:returns: generator of :class:`User <github3.users.User>`\ s
881881
"""
882882
url = self._build_url('assignees', base_url=self._api)
883883
return self._iter(int(number), url, User, etag=etag)
@@ -889,7 +889,7 @@ def iter_branches(self, number=-1, etag=None):
889889
-1 returns all branches
890890
:param str etag: (optional), ETag from a previous request to the same
891891
endpoint
892-
:returns: list of :class:`Branch <Branch>`\ es
892+
:returns: generator of :class:`Branch <Branch>`\ es
893893
"""
894894
url = self._build_url('branches', base_url=self._api)
895895
return self._iter(int(number), url, Branch, etag=etag)
@@ -925,7 +925,7 @@ def iter_comments(self, number=-1, etag=None):
925925
-1 returns all comments
926926
:param str etag: (optional), ETag from a previous request to the same
927927
endpoint
928-
:returns: list of :class:`RepoComment <RepoComment>`\ s
928+
:returns: generator of :class:`RepoComment <RepoComment>`\ s
929929
"""
930930
url = self._build_url('comments', base_url=self._api)
931931
return self._iter(int(number), url, RepoComment, etag=etag)
@@ -939,7 +939,7 @@ def iter_comments_on_commit(self, sha, number=1, etag=None):
939939
-1 returns all comments
940940
:param str etag: (optional), ETag from a previous request to the same
941941
endpoint
942-
:returns: list of :class:`RepoComment <RepoComment>`\ s
942+
:returns: generator of :class:`RepoComment <RepoComment>`\ s
943943
"""
944944
url = self._build_url('commits', sha, 'comments', base_url=self._api)
945945
return self._iter(int(number), url, RepoComment, etag=etag)
@@ -980,7 +980,7 @@ def iter_commits(self, sha=None, path=None, author=None, number=-1,
980980
-1 returns all comments
981981
:param str etag: (optional), ETag from a previous request to the same
982982
endpoint
983-
:returns: list of :class:`RepoCommit <RepoCommit>`\ s
983+
:returns: generator of :class:`RepoCommit <RepoCommit>`\ s
984984
"""
985985
params = {'sha': sha, 'path': path, 'author': author}
986986
self._remove_none(params)
@@ -996,7 +996,7 @@ def iter_contributors(self, anon=False, number=-1, etag=None):
996996
Default: -1 returns all contributors
997997
:param str etag: (optional), ETag from a previous request to the same
998998
endpoint
999-
:returns: list of :class:`User <github3.users.User>`\ s
999+
:returns: generator of :class:`User <github3.users.User>`\ s
10001000
"""
10011001
url = self._build_url('contributors', base_url=self._api)
10021002
params = {}
@@ -1039,7 +1039,7 @@ def iter_downloads(self, number=-1, etag=None):
10391039
-1 returns all available downloads
10401040
:param str etag: (optional), ETag from a previous request to the same
10411041
endpoint
1042-
:returns: list of :class:`Download <Download>`\ s
1042+
:returns: generator of :class:`Download <Download>`\ s
10431043
"""
10441044
url = self._build_url('downloads', base_url=self._api)
10451045
return self._iter(int(number), url, Download, etag=etag)
@@ -1051,7 +1051,7 @@ def iter_events(self, number=-1, etag=None):
10511051
returns all available events
10521052
:param str etag: (optional), ETag from a previous request to the same
10531053
endpoint
1054-
:returns: list of :class:`Event <github3.events.Event>`\ s
1054+
:returns: generator of :class:`Event <github3.events.Event>`\ s
10551055
"""
10561056
url = self._build_url('events', base_url=self._api)
10571057
return self._iter(int(number), url, Event, etag=etag)
@@ -1065,7 +1065,7 @@ def iter_forks(self, sort='', number=-1, etag=None):
10651065
returns all forks
10661066
:param str etag: (optional), ETag from a previous request to the same
10671067
endpoint
1068-
:returns: list of :class:`Repository <Repository>`
1068+
:returns: generator of :class:`Repository <Repository>`
10691069
"""
10701070
url = self._build_url('forks', base_url=self._api)
10711071
params = {}
@@ -1081,7 +1081,7 @@ def iter_hooks(self, number=-1, etag=None):
10811081
returns all hooks
10821082
:param str etag: (optional), ETag from a previous request to the same
10831083
endpoint
1084-
:returns: list of :class:`Hook <Hook>`\ s
1084+
:returns: generator of :class:`Hook <Hook>`\ s
10851085
"""
10861086
url = self._build_url('hooks', base_url=self._api)
10871087
return self._iter(int(number), url, Hook, etag=etag)
@@ -1112,7 +1112,7 @@ def iter_issues(self,
11121112
By default all issues are returned
11131113
:param str etag: (optional), ETag from a previous request to the same
11141114
endpoint
1115-
:returns: list of :class:`Issue <github3.issues.Issue>`\ s
1115+
:returns: generator of :class:`Issue <github3.issues.Issue>`\ s
11161116
"""
11171117
url = self._build_url('issues', base_url=self._api)
11181118

@@ -1172,7 +1172,7 @@ def iter_languages(self, number=-1, etag=None):
11721172
-1 returns all used languages
11731173
:param str etag: (optional), ETag from a previous request to the same
11741174
endpoint
1175-
:returns: list of tuples
1175+
:returns: generator of tuples
11761176
"""
11771177
url = self._build_url('languages', base_url=self._api)
11781178
return self._iter(int(number), url, tuple, etag=etag)

0 commit comments

Comments
 (0)
0