8000 Start using the different User classes · pythonthings/github3.py@c2400e1 · GitHub
[go: up one dir, main page]

Skip to content

Commit c2400e1

Browse files
committed
Start using the different User classes
1 parent f8de3b7 commit c2400e1

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

github3/github.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,10 @@ def all_users(self, number=-1, etag=None, per_page=None, since=None):
145145
:param str etag: (optional), ETag from a previous request to the same
146146
endpoint
147147
:param int per_page: (optional), number of users to list per request
148-
:returns: generator of :class:`User <github3.users.User>`
148+
:returns: generator of :class:`~github3.users.ShortUser`
149149
"""
150150
url = self._build_url('users')
151-
return self._iter(int(number), url, users.User, etag=etag,
151+
return self._iter(int(number), url, users.ShortUser, etag=etag,
152152
params={'per_page': per_page, 'since': since})
153153

154154
@requires_basic_auth
@@ -447,7 +447,7 @@ def follow(self, username):
447447
return resp
448448

449449
def followed_by(self, username, number=-1, etag=None):
450-
"""Iterate over users being followed by ``username``.
450+
r"""Iterate over users being followed by ``username``.
451451
452452
.. versionadded:: 1.0.0
453453
@@ -458,14 +458,14 @@ def followed_by(self, username, number=-1, etag=None):
458458
returns all people you follow
459459
:param str etag: (optional), ETag from a previous request to the same
460460
endpoint
461-
:returns: generator of :class:`User <github3.users.User>`\ s
461+
:returns: generator of :class:`~github3.users.ShortUser`\ s
462462
"""
463463
url = self._build_url('users', username, 'following')
464-
return self._iter(int(number), url, users.User, etag=etag)
464+
return self._iter(int(number), url, users.ShortUser, etag=etag)
465465

466466
@requires_auth
467467
def followers(self, number=-1, etag=None):
468-
"""Iterate over followers of the authenticated user.
468+
r"""Iterate over followers of the authenticated user.
469469
470470
.. versionadded:: 1.0.0
471471
@@ -475,13 +475,13 @@ def followers(self, number=-1, etag=None):
475475
-1 returns all followers
476476
:param str etag: (optional), ETag from a previous request to the same
477477
endpoint
478-
:returns: generator of :class:`User <github3.users.User>`\ s
478+
:returns: generator of :class:`~github3.users.ShortUser`\ s
479479
"""
480480
url = self._build_url('user', 'followers')
481-
return self._iter(int(number), url, users.User, etag=etag)
481+
return self._iter(int(number), url, users.ShortUser, etag=etag)
482482

483483
def followers_of(self, username, number=-1, etag=None):
484-
"""Iterate over followers of ``username``.
484+
r"""Iterate over followers of ``username``.
485485
486486
.. versionadded:: 1.0.0
487487
@@ -492,14 +492,14 @@ def followers_of(self, username, number=-1, etag=None):
492492
-1 returns all followers
493493
:param str etag: (optional), ETag from a previous request to the same
494494
endpoint
495-
:returns: generator of :class:`User <github3.users.User>`\ s
495+
:returns: generator of :class:`~github3.users.ShortUser`\ s
496496
"""
497497
url = self._build_url('users', username, 'followers')
498-
return self._iter(int(number), url, users.User, etag=etag)
498+
return self._iter(int(number), url, users.ShortUser, etag=etag)
499499

500500
@requires_auth
501501
def following(self, number=-1, etag=None):
502-
"""Iterate over users the authenticated user is following.
502+
r"""Iterate over users the authenticated user is following.
503503
504504
.. versionadded:: 1.0.0
505505
@@ -509,10 +509,10 @@ def following(self, number=-1, etag=None):
509509
returns all people you follow
510510
:param str etag: (optional), ETag from a previous request to the same
511511
endpoint
512-
:returns: generator of :class:`User <github3.users.User>`\ s
512+
:returns: generator of :class:`~github3.users.ShortUser`\ s
513513
"""
514514
url = self._build_url('user', 'following')
515-
return self._iter(int(number), url, users.User, etag=etag)
515+
return self._iter(int(number), url, users.ShortUser, etag=etag)
516516

517517
def gist(self, id_num):
518518
"""Retrieve the gist using the specified id number.
@@ -800,18 +800,18 @@ def markdown(self, text, mode='', context='', raw=False):
800800

801801
@requires_auth
802802
def me(self):
803-
"""Retrieves the info for the authenticated user.
803+
"""Retrieve the info for the authenticated user.
804804
805805
.. versionadded:: 1.0
806806
807807
This was separated from the ``user`` method.
808808
809809
:returns: The representation of the authenticated user.
810-
:rtype: :class:`User <github3.users.User>`
810+
:rtype: :class:`~github3.users.AuthenticatedUser`
811811
"""
812812
url = self._build_url('user')
813813
json = self._json(self._get(url), 200)
814-
return self._instance_or_null(users.User, json)
814+
return self._instance_or_null(users.AuthenticatedUser, json)
815815

816816
@requires_auth
817817
def membership_in(self, organization):
@@ -1588,10 +1588,10 @@ def update_me(self, name=None, email=None, blog=None, company=None,
15881588
return False
15891589

15901590
def user(self, username):
1591-
"""Returns a User object for the specified user name.
1591+
"""Retrieve a User object for the specified user name.
15921592
15931593
:param str username: name of the user
1594-
:returns: :class:`User <github3.users.User>`
1594+
:returns: :class:`~github3.users.User`
15951595
"""
15961596
url = self._build_url('users', username)
15971597
json = self._json(self._get(url), 200)
@@ -1657,7 +1657,7 @@ def user_with_id(self, number):
16571657
"""Get the user's information with id ``number``.
16581658
16591659
:param int number: the user's id number
1660-
:returns: :class:`User <github3.users.User>`
1660+
:returns: :class:`~github3.users.User`
16611661
"""
16621662
number = int(number)
16631663
json = None

0 commit comments

Comments
 (0)
0