Skip to content

Commit f2a9ffb

Browse files
committed
Update docstrings in github3.users
1 parent ec45c9d commit f2a9ffb

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

github3/users.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ def events(self, public=False, number=-1, etag=None):
268268
returns all available events.
269269
:param str etag: (optional), ETag from a previous request to the same
270270
endpoint
271-
:returns: list of :class:`Event <github3.events.Event>`\ s
271+
:returns: generator of :class:`Event <github3.events.Event>`\ s
272272
"""
273273
path = ['events']
274274
if public:
@@ -324,7 +324,7 @@ def organization_events(self, org, number=-1, etag=None):
324324
returns all available events
325325
:param str etag: (optional), ETag from a previous request to the same
326326
endpoint
327-
:returns: list of :class:`Event <github3.events.Event>`\ s
327+
:returns: generator of :class:`Event <github3.events.Event>`\ s
328328
"""
329329
url = ''
330330
if org:
@@ -357,7 +357,7 @@ def organizations(self, number=-1, etag=None):
357357
Default: -1 returns all available organization
358358
:param str etag: (optional), ETag from a previous request to the same
359359
endpoint
360-
:returns: list of :class:`Event <github3.orgs.Organization>`\ s
360+
:returns: generator of :class:`Event <github3.orgs.Organization>`\ s
361361
"""
362362
# Import here, because a toplevel import causes an import loop
363363
from .orgs import Organization

0 commit comments

Comments
 (0)