aboutsummaryrefslogtreecommitdiff
path: root/discord/user.py
diff options
context:
space:
mode:
authorVexs <[email protected]>2019-05-14 16:51:50 -0500
committerRapptz <[email protected]>2019-05-14 19:13:48 -0400
commitbf5b267c5586a59b16ae8af0038cb628667333d5 (patch)
treec7d88281a339b0d614791f3fa9b78a04508923a8 /discord/user.py
parentAdded note to Emoji.user (diff)
downloaddiscord.py-bf5b267c5586a59b16ae8af0038cb628667333d5.tar.xz
discord.py-bf5b267c5586a59b16ae8af0038cb628667333d5.zip
Correct the documentation for methods and properties that return Assets
Diffstat (limited to 'discord/user.py')
-rw-r--r--discord/user.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/discord/user.py b/discord/user.py
index a47e5351..4bd942d0 100644
--- a/discord/user.py
+++ b/discord/user.py
@@ -114,10 +114,10 @@ class BaseUser(_BaseUser):
@property
def avatar_url(self):
- """Returns a friendly URL version of the avatar the user has.
+ """Returns a :class:`Asset`: for the avatar the user has.
- If the user does not have a traditional avatar, their default
- avatar URL is returned instead.
+ If the user does not have a traditional avatar, an asset for
+ the default avatar is returned instead.
This is equivalent to calling :meth:`avatar_url_as` with
the default parameters (i.e. webp/gif detection and a size of 1024).
@@ -129,10 +129,10 @@ class BaseUser(_BaseUser):
return bool(self.avatar and self.avatar.startswith('a_'))
def avatar_url_as(self, *, format=None, static_format='webp', size=1024):
- """Returns a friendly URL version of the avatar the user has.
+ """Returns a :class:`Asset`: for the avatar the user has.
- If the user does not have a traditional avatar, their default
- avatar URL is returned instead.
+ If the user does not have a traditional avatar, an asset for
+ the default avatar is returned instead.
The format must be one of 'webp', 'jpeg', 'jpg', 'png' or 'gif', and
'gif' is only valid for animated avatars. The size must be a power of 2