mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-04-20 16:00:29 +00:00
Code Issues Projects Releases Wiki Activity

Mention what can be done during initialisation in embeds.

Browse Source
This commit is contained in:
Rapptz 2019-05-07 00:24:25 -04:00
parent bdea50e1db
commit 792b31833a
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
discord/embeds.py
View File

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