aboutsummaryrefslogtreecommitdiff
path: root/discord/embeds.py
diff options
context:
space:
mode:
authorNCPlayz <[email protected]>2019-03-16 21:43:55 +0000
committerRapptz <[email protected]>2019-03-19 08:24:42 -0400
commitfb02191b80972a9cf7c3baa765cb3aa84c6f1cfa (patch)
tree7a0a5c9aaa5cc5bac26fc51caf4fdffbaee64c26 /discord/embeds.py
parentTake back ownership of files from aiohttp for retrying requests. (diff)
downloaddiscord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.tar.xz
discord.py-fb02191b80972a9cf7c3baa765cb3aa84c6f1cfa.zip
Organise documentation
Diffstat (limited to 'discord/embeds.py')
-rw-r--r--discord/embeds.py30
1 files changed, 15 insertions, 15 deletions
diff --git a/discord/embeds.py b/discord/embeds.py
index 7b4ecccb..3ad3fd57 100644
--- a/discord/embeds.py
+++ b/discord/embeds.py
@@ -238,9 +238,9 @@ class Embed:
Parameters
-----------
- text: str
+ text: :class:`str`
The footer text.
- icon_url: str
+ icon_url: :class:`str`
The URL of the footer icon. Only HTTP(S) is supported.
"""
@@ -276,7 +276,7 @@ class Embed:
Parameters
-----------
- url: str
+ url: :class:`str`
The source URL for the image. Only HTTP(S) is supported.
"""
@@ -309,7 +309,7 @@ class Embed:
Parameters
-----------
- url: str
+ url: :class:`str`
The source URL for the thumbnail. Only HTTP(S) is supported.
"""
@@ -361,11 +361,11 @@ class Embed:
Parameters
-----------
- name: str
+ name: :class:`str`
The name of the author.
- url: str
+ url: :class:`str`
The URL for the author.
- icon_url: str
+ icon_url: :class:`str`
The URL of the author icon. Only HTTP(S) is supported.
"""
@@ -399,11 +399,11 @@ class Embed:
Parameters
-----------
- name: str
+ name: :class:`str`
The name of the field.
- value: str
+ value: :class:`str`
The value of the field.
- inline: bool
+ inline: :class:`bool`
Whether the field should be displayed inline.
"""
@@ -440,7 +440,7 @@ class Embed:
Parameters
-----------
- index: int
+ index: :class:`int`
The index of the field to remove.
"""
try:
@@ -458,13 +458,13 @@ class Embed:
Parameters
-----------
- index: int
+ index: :class:`int`
The index of the field to modify.
- name: str
+ name: :class:`str`
The name of the field.
- value: str
+ value: :class:`str`
The value of the field.
- inline: bool
+ inline: :class:`bool`
Whether the field should be displayed inline.
Raises