@@ -145,10 +145,10 @@ def all_users(self, number=-1, etag=None, per_page=None, since=None):
145
145
:param str etag: (optional), ETag from a previous request to the same
146
146
endpoint
147
147
: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 `
149
149
"""
150
150
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 ,
152
152
params = {'per_page' : per_page , 'since' : since })
153
153
154
154
@requires_basic_auth
@@ -447,7 +447,7 @@ def follow(self, username):
447
447
return resp
448
448
449
449
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``.
451
451
452
452
.. versionadded:: 1.0.0
453
453
@@ -458,14 +458,14 @@ def followed_by(self, username, number=-1, etag=None):
458
458
returns all people you follow
459
459
:param str etag: (optional), ETag from a previous request to the same
460
460
endpoint
461
- :returns: generator of :class:`User < github3.users.User> `\ s
461
+ :returns: generator of :class:`~ github3.users.ShortUser `\ s
462
462
"""
463
463
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 )
465
465
466
466
@requires_auth
467
467
def followers (self , number = - 1 , etag = None ):
468
- """Iterate over followers of the authenticated user.
468
+ r """Iterate over followers of the authenticated user.
469
469
470
470
.. versionadded:: 1.0.0
471
471
@@ -475,13 +475,13 @@ def followers(self, number=-1, etag=None):
475
475
-1 returns all followers
476
476
:param str etag: (optional), ETag from a previous request to the same
477
477
endpoint
478
- :returns: generator of :class:`User < github3.users.User> `\ s
478
+ :returns: generator of :class:`~ github3.users.ShortUser `\ s
479
479
"""
480
480
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 )
482
482
483
483
def followers_of (self , username , number = - 1 , etag = None ):
484
- """Iterate over followers of ``username``.
484
+ r """Iterate over followers of ``username``.
485
485
486
486
.. versionadded:: 1.0.0
487
487
@@ -492,14 +492,14 @@ def followers_of(self, username, number=-1, etag=None):
492
492
-1 returns all followers
493
493
:param str etag: (optional), ETag from a previous request to the same
494
494
endpoint
495
- :returns: generator of :class:`User < github3.users.User> `\ s
495
+ :returns: generator of :class:`~ github3.users.ShortUser `\ s
496
496
"""
497
497
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 )
499
499
500
500
@requires_auth
501
501
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.
503
503
504
504
.. versionadded:: 1.0.0
505
505
@@ -509,10 +509,10 @@ def following(self, number=-1, etag=None):
509
509
returns all people you follow
510
510
:param str etag: (optional), ETag from a previous request to the same
511
511
endpoint
512
- :returns: generator of :class:`User < github3.users.User> `\ s
512
+ :returns: generator of :class:`~ github3.users.ShortUser `\ s
513
513
"""
514
514
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 )
516
516
517
517
def gist (self , id_num ):
518
518
"""Retrieve the gist using the specified id number.
@@ -800,18 +800,18 @@ def markdown(self, text, mode='', context='', raw=False):
800
800
801
801
@requires_auth
802
802
def me (self ):
803
- """Retrieves the info for the authenticated user.
803
+ """Retrieve the info for the authenticated user.
804
804
805
805
.. versionadded:: 1.0
806
806
807
807
This was separated from the ``user`` method.
808
808
809
809
:returns: The representation of the authenticated user.
810
- :rtype: :class:`User < github3.users.User> `
810
+ :rtype: :class:`~ github3.users.AuthenticatedUser `
811
811
"""
812
812
url = self ._build_url ('user' )
813
813
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 )
815
815
816
816
@requires_auth
817
817
def membership_in (self , organization ):
@@ -1588,10 +1588,10 @@ def update_me(self, name=None, email=None, blog=None, company=None,
1588
1588
return False
1589
1589
1590
1590
def user (self , username ):
1591
- """Returns a User object for the specified user name.
1591
+ """Retrieve a User object for the specified user name.
1592
1592
1593
1593
:param str username: name of the user
1594
- :returns: :class:`User < github3.users.User> `
1594
+ :returns: :class:`~ github3.users.User`
1595
1595
"""
1596
1596
url = self ._build_url ('users' , username )
1597
1597
json = self ._json (self ._get (url ), 200 )
@@ -1657,7 +1657,7 @@ def user_with_id(self, number):
1657
1657
"""Get the user's information with id ``number``.
1658
1658
1659
1659
:param int number: the user's id number
1660
- :returns: :class:`User < github3.users.User> `
1660
+ :returns: :class:`~ github3.users.User`
1661
1661
"""
1662
1662
number = int (number )
1663
1663
json = None
0 commit comments