aboutsummaryrefslogtreecommitdiff
path: root/discord/embeds.py
diff options
context:
space:
mode:
authorSebastian Law <[email protected]>2020-06-28 00:45:58 -0700
committerGitHub <[email protected]>2020-06-28 03:45:58 -0400
commitb4b953bfc66adc235e06774b0481ceb847753793 (patch)
tree2d0cbd871944e3a5184b2dbec75dc59ddabad6d5 /discord/embeds.py
parentFix a KeyError for channels with no category in Guild.by_category (diff)
downloaddiscord.py-b4b953bfc66adc235e06774b0481ceb847753793.tar.xz
discord.py-b4b953bfc66adc235e06774b0481ceb847753793.zip
Fix various inconsistencies within the documentation (#5067)
Diffstat (limited to 'discord/embeds.py')
-rw-r--r--discord/embeds.py14
1 files changed, 7 insertions, 7 deletions
diff --git a/discord/embeds.py b/discord/embeds.py
index e02918ef..7bbe8030 100644
--- a/discord/embeds.py
+++ b/discord/embeds.py
@@ -224,7 +224,7 @@ class Embed:
@property
def footer(self):
- """Returns an ``EmbedProxy`` denoting the footer contents.
+ """Union[:class:`EmbedProxy`, :attr:`Empty`]: Returns an ``EmbedProxy`` denoting the footer contents.
See :meth:`set_footer` for possible values you can access.
@@ -257,7 +257,7 @@ class Embed:
@property
def image(self):
- """Returns an ``EmbedProxy`` denoting the image contents.
+ """Union[:class:`EmbedProxy`, :attr:`Empty`]: Returns an ``EmbedProxy`` denoting the image contents.
Possible attributes you can access are:
@@ -296,7 +296,7 @@ class Embed:
@property
def thumbnail(self):
- """Returns an ``EmbedProxy`` denoting the thumbnail contents.
+ """Union[:class:`EmbedProxy`, :attr:`Empty`]: Returns an ``EmbedProxy`` denoting the thumbnail contents.
Possible attributes you can access are:
@@ -335,7 +335,7 @@ class Embed:
@property
def video(self):
- """Returns an ``EmbedProxy`` denoting the video contents.
+ """Union[:class:`EmbedProxy`, :attr:`Empty`]: Returns an ``EmbedProxy`` denoting the video contents.
Possible attributes include:
@@ -349,7 +349,7 @@ class Embed:
@property
def provider(self):
- """Returns an ``EmbedProxy`` denoting the provider contents.
+ """Union[:class:`EmbedProxy`, :attr:`Empty`]: Returns an ``EmbedProxy`` denoting the provider contents.
The only attributes that might be accessed are ``name`` and ``url``.
@@ -359,7 +359,7 @@ class Embed:
@property
def author(self):
- """Returns an ``EmbedProxy`` denoting the author contents.
+ """Union[:class:`EmbedProxy`, :attr:`Empty`]: Returns an ``EmbedProxy`` denoting the author contents.
See :meth:`set_author` for possible values you can access.
@@ -412,7 +412,7 @@ class Embed:
@property
def fields(self):
- """Returns a :class:`list` of ``EmbedProxy`` denoting the field contents.
+ """Union[List[:class:`EmbedProxy`], :attr:`Empty`]: Returns a :class:`list` of ``EmbedProxy`` denoting the field contents.
See :meth:`add_field` for possible values you can access.