aboutsummaryrefslogtreecommitdiff
path: root/discord/webhook.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/webhook.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/webhook.py')
-rw-r--r--discord/webhook.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/discord/webhook.py b/discord/webhook.py
index 716963b9..88406937 100644
--- a/discord/webhook.py
+++ b/discord/webhook.py
@@ -523,10 +523,10 @@ class Webhook:
@property
def avatar_url(self):
- """Returns a friendly URL version of the avatar the webhook has.
+ """Returns a :class:`Asset`: for the avatar the webhook has.
- If the webhook does not have a traditional avatar, their default
- avatar URL is returned instead.
+ If the webhook 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.
@@ -534,10 +534,10 @@ class Webhook:
return self.avatar_url_as()
def avatar_url_as(self, *, format=None, size=1024):
- """Returns a friendly URL version of the avatar the webhook has.
+ """Returns a :class:`Asset`: for the avatar the webhook has.
- If the webhook does not have a traditional avatar, their default
- avatar URL is returned instead.
+ If the webhook does not have a traditional avatar, an asset for
+ the default avatar is returned instead.
The format must be one of 'jpeg', 'jpg', or 'png'.
The size must be a power of 2 between 16 and 1024.