matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Add intersphinx

Browse Source
This commit is contained in:
Tobotimus
2018-01-06 17:21:56 -05:00
committed by Rapptz
parent 0ef866a704
commit 3112e1c17e
37 changed files with 267 additions and 268 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
discord/user.py
View File

@ -100,7 +100,7 @@ class BaseUser(_BaseUser):
return self.avatar_url_as(format=None, size=1024)
def is_avatar_animated(self):
"""bool: Returns True if the user has an animated avatar."""
""":class:`bool`: Returns True if the user has an animated avatar."""
return bool(self.avatar and self.avatar.startswith('a_'))
def avatar_url_as(self, *, format=None, static_format='webp', size=1024):
@ -249,23 +249,23 @@ class ClientUser(BaseUser):
Attributes
-----------
name: str
name: :class:`str`
The user's username.
id: int
id: :class:`int`
The user's unique ID.
discriminator: str
discriminator: :class:`str`
The user's discriminator. This is given when the username has conflicts.
avatar: Optional[str]
avatar: Optional[:class:`str`]
The avatar hash the user has. Could be None.
bot: bool
bot: :class:`bool`
Specifies if the user is a bot account.
verified: bool
verified: :class:`bool`
Specifies if the user is a verified account.
email: Optional[str]
email: Optional[:class:`str`]
The email the user used when registering.
mfa_enabled: bool
mfa_enabled: :class:`bool`
Specifies if the user has MFA turned on and working.
premium: bool
premium: :class:`bool`
Specifies if the user is a premium user (e.g. has Discord Nitro).
"""
__slots__ = ('email', 'verified', 'mfa_enabled', 'premium', '_relationships')
@ -300,17 +300,17 @@ class ClientUser(BaseUser):
@property
def relationships(self):
"""Returns a list of :class:`Relationship` that the user has."""
"""Returns a :class:`list` of :class:`Relationship` that the user has."""
return list(self._relationships.values())
@property
def friends(self):
"""Returns a list of :class:`User`\s that the user is friends with."""
"""Returns a :class:`list` of :class:`User`\s that the user is friends with."""
return [r.user for r in self._relationships.values() if r.type is RelationshipType.friend]
@property
def blocked(self):
"""Returns a list of :class:`User`\s that the user has blocked."""
"""Returns a :class:`list` of :class:`User`\s that the user has blocked."""
return [r.user for r in self._relationships.values() if r.type is RelationshipType.blocked]
@asyncio.coroutine
@ -411,7 +411,7 @@ class ClientUser(BaseUser):
Parameters
-----------
\*recipients
An argument list of :class:`User` to have in
An argument :class:`list` of :class:`User` to have in
your group.
Return
@ -460,15 +460,15 @@ class User(BaseUser, discord.abc.Messageable):
Attributes
-----------
name: str
name: :class:`str`
The user's username.
id: int
id: :class:`int`
The user's unique ID.
discriminator: str
discriminator: :class:`str`
The user's discriminator. This is given when the username has conflicts.
avatar: Optional[str]
avatar: Optional[:class:`str`]
The avatar hash the user has. Could be None.
bot: bool
bot: :class:`bool`
Specifies if the user is a bot account.
"""
@ -512,14 +512,14 @@ class User(BaseUser, discord.abc.Messageable):
return self._state.user.get_relationship(self.id)
def is_friend(self):
"""bool: Checks if the user is your friend."""
""":class:`bool`: Checks if the user is your friend."""
r = self.relationship
if r is None:
return False
return r.type is RelationshipType.friend
def is_blocked(self):
"""bool: Checks if the user is blocked."""
""":class:`bool`: Checks if the user is blocked."""
r = self.relationship
if r is None:
return False