aboutsummaryrefslogtreecommitdiff
path: root/discord/guild.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/guild.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/guild.py')
-rw-r--r--discord/guild.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/discord/guild.py b/discord/guild.py
index 3dd28533..fc59ce70 100644
--- a/discord/guild.py
+++ b/discord/guild.py
@@ -418,11 +418,11 @@ class Guild(Hashable):
@property
def icon_url(self):
- """Returns the URL version of the guild's icon. Returns an empty string if it has no icon."""
+ """:class:`Asset`: Returns the guild's icon asset."""
return self.icon_url_as()
def icon_url_as(self, *, format='webp', size=1024):
- """Returns a friendly URL version of the guild's icon. Returns an empty string if it has no icon.
+ """Returns a :class:`Asset`: for the guild's icon.
The format must be one of 'webp', 'jpeg', 'jpg', or 'png'. The
size must be a power of 2 between 16 and 4096.
@@ -448,11 +448,11 @@ class Guild(Hashable):
@property
def banner_url(self):
- """Returns the URL version of the guild's banner. Returns an empty string if it has no banner."""
+ """:class:`Asset`: Returns the guild's banner asset."""
return self.banner_url_as()
def banner_url_as(self, *, format='webp', size=2048):
- """Returns a friendly URL version of the guild's banner. Returns an empty string if it has no banner.
+ """Returns a :class:`Asset`: for the guild's banner.
The format must be one of 'webp', 'jpeg', or 'png'. The
size must be a power of 2 between 16 and 4096.
@@ -478,11 +478,11 @@ class Guild(Hashable):
@property
def splash_url(self):
- """Returns the URL version of the guild's invite splash. Returns an empty string if it has no splash."""
+ """:class:`Asset`: Returns the guild's invite splash asset."""
return self.splash_url_as()
def splash_url_as(self, *, format='webp', size=2048):
- """Returns a friendly URL version of the guild's invite splash. Returns an empty string if it has no splash.
+ """Returns a :class:`Asset`: for the guild's invite splash.
The format must be one of 'webp', 'jpeg', 'jpg', or 'png'. The
size must be a power of 2 between 16 and 4096.