mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-09-06 09:56:09 +00:00
Code Issues Projects Releases Wiki Activity

Fix various inconsistencies within the documentation (#5067)

Browse Source
This commit is contained in:
Sebastian Law
2020-06-28 00:45:58 -07:00
committed by GitHub
parent f94b00cb48
commit b4b953bfc6
24 changed files with 378 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
discord/embeds.py
View File

@ -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.