aboutsummaryrefslogtreecommitdiff
path: root/discord/embeds.py
diff options
context:
space:
mode:
authorTobotimus <[email protected]>2018-01-06 17:21:56 -0500
committerRapptz <[email protected]>2018-01-06 17:23:59 -0500
commit3112e1c17e7859adf6d13ed844f4c636b4bc30d8 (patch)
tree70d7aafca549a8c245ee4fdab774e1ab5302d531 /discord/embeds.py
parent[commands] Fix MissingRequiredArgument param handling (diff)
downloaddiscord.py-3112e1c17e7859adf6d13ed844f4c636b4bc30d8.tar.xz
discord.py-3112e1c17e7859adf6d13ed844f4c636b4bc30d8.zip
Add intersphinx
Diffstat (limited to 'discord/embeds.py')
-rw-r--r--discord/embeds.py18
1 files changed, 9 insertions, 9 deletions
diff --git a/discord/embeds.py b/discord/embeds.py
index 77d0c7b9..179250ca 100644
--- a/discord/embeds.py
+++ b/discord/embeds.py
@@ -58,27 +58,27 @@ class Embed:
of the object:
Certain properties return an ``EmbedProxy``. Which is a type
- that acts similar to a regular `dict` except access the attributes
+ that acts similar to a regular :class:`dict` except access the attributes
via dotted access, e.g. ``embed.author.icon_url``. If the attribute
is invalid or empty, then a special sentinel value is returned,
:attr:`Embed.Empty`.
- For ease of use, all parameters that expect a ``str`` are implicitly
- casted to ``str`` for you.
+ For ease of use, all parameters that expect a :class:`str` are implicitly
+ casted to :class:`str` for you.
Attributes
-----------
- title: str
+ title: :class:`str`
The title of the embed.
- type: str
+ type: :class:`str`
The type of embed. Usually "rich".
- description: str
+ description: :class:`str`
The description of the embed.
- url: str
+ url: :class:`str`
The URL of the embed.
timestamp: `datetime.datetime`
The timestamp of the embed content. This could be a naive or aware datetime.
- colour: :class:`Colour` or int
+ colour: :class:`Colour` or :class:`int`
The colour code of the embed. Aliased to ``color`` as well.
Empty
A special sentinel value used by ``EmbedProxy`` and this class
@@ -334,7 +334,7 @@ class Embed:
@property
def fields(self):
- """Returns a list of ``EmbedProxy`` denoting the field contents.
+ """Returns a :class:`list` of ``EmbedProxy`` denoting the field contents.
See :meth:`add_field` for possible values you can access.