aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRapptz <[email protected]>2019-05-07 00:24:25 -0400
committerRapptz <[email protected]>2019-05-07 00:24:25 -0400
commit792b31833a1390ecdd43003647456a3e7c9d9231 (patch)
treeb10080abbdaad21396a8173a21760b1e1d991edd
parent[commands] Better note for Command.invoke (diff)
downloaddiscord.py-792b31833a1390ecdd43003647456a3e7c9d9231.tar.xz
discord.py-792b31833a1390ecdd43003647456a3e7c9d9231.zip
Mention what can be done during initialisation in embeds.
-rw-r--r--discord/embeds.py9
1 files changed, 6 insertions, 3 deletions
diff --git a/discord/embeds.py b/discord/embeds.py
index 3ad3fd57..b9ae584e 100644
--- a/discord/embeds.py
+++ b/discord/embeds.py
@@ -64,9 +64,6 @@ class Embed:
Returns the total size of the embed.
Useful for checking if it's within the 6000 character limit.
- The following attributes can be set during creation
- of the object:
-
Certain properties return an ``EmbedProxy``. Which is a type
that acts similar to a regular :class:`dict` except access the attributes
via dotted access, e.g. ``embed.author.icon_url``. If the attribute
@@ -80,16 +77,22 @@ class Embed:
-----------
title: :class:`str`
The title of the embed.
+ This can be set during initialisation.
type: :class:`str`
The type of embed. Usually "rich".
+ This can be set during initialisation.
description: :class:`str`
The description of the embed.
+ This can be set during initialisation.
url: :class:`str`
The URL of the embed.
+ This can be set during initialisation.
timestamp: `datetime.datetime`
The timestamp of the embed content. This could be a naive or aware datetime.
+ This can be set during initialisation.
colour: :class:`Colour` or :class:`int`
The colour code of the embed. Aliased to ``color`` as well.
+ This can be set during initialisation.
Empty
A special sentinel value used by ``EmbedProxy`` and this class
to denote that the value or attribute is empty.