aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2021-04-28 01:37:26 -0400
committerRapptz <[email protected]>2021-05-27 00:53:14 -0400
commiteda668037718e9ee8a99ea9f5773149c22fedce2 (patch)
tree5bd92e3355d99916b8513a1ecfac8ef4dbdbe4d0 /docs
parentProperly guard for DMs in interaction creation (diff)
downloaddiscord.py-eda668037718e9ee8a99ea9f5773149c22fedce2.tar.xz
discord.py-eda668037718e9ee8a99ea9f5773149c22fedce2.zip
Rename enums to use official API naming
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst29
1 files changed, 15 insertions, 14 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 5c869822..41eabc3c 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1194,9 +1194,10 @@ of :class:`enum.Enum`.
.. attribute:: deferred_channel_message
Responds to a slash command with a message at a later time.
- .. attribute:: ack
+ .. attribute:: deferred_message_update
- Acknowledges the component interaction.
+ Acknowledges the component interaction with a promise that
+ the message will update later (though there is no need to actually update the message).
.. class:: ComponentType
@@ -1204,9 +1205,9 @@ of :class:`enum.Enum`.
.. versionadded:: 2.0
- .. attribute:: group
+ .. attribute:: action_row
- Represents the group component which holds different components.
+ Represents the group component which holds different components in a row.
.. attribute:: button
Represents a button component.
@@ -1217,21 +1218,21 @@ of :class:`enum.Enum`.
.. versionadded:: 2.0
- .. attribute:: blurple::
+ .. attribute:: primary::
- Represents a blurple button.
- .. attribute:: grey::
+ Represents a blurple button for the primary action.
+ .. attribute:: secondary::
- Represents a grey button.
- .. attribute:: green::
+ Represents a grey button for the secondary action.
+ .. attribute:: success::
- Represents a green button.
- .. attribute:: red::
+ Represents a green button for a successful action.
+ .. attribute:: danger::
- Represents a red button.
- .. attribute:: hyperlink::
+ Represents a red button for a dangerous action.
+ .. attribute:: link::
- Represents a hyperlink button.
+ Represents a link button.
.. class:: VoiceRegion