aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst8
-rw-r--r--docs/ext/commands/api.rst3
-rw-r--r--docs/ext/commands/commands.rst3
3 files changed, 10 insertions, 4 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 16254a75..214fd8c8 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -304,7 +304,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
called regardless of the state of the internal message cache.
:param emoji: The custom or unicode emoji being reacted to.
- :type emoji: :class:`PartialReactionEmoji`
+ :type emoji: :class:`PartialEmoji`
:param int message_id: The message ID of the message being reacted.
:param int channel_id: The channel ID where the message belongs to.
:param int user_id: The user ID of the user who did the reaction.
@@ -328,7 +328,7 @@ to handle it, which defaults to print a traceback and ignoring the exception.
called regardless of the state of the internal message cache.
:param emoji: The custom or unicode emoji that got un-reacted.
- :type emoji: :class:`PartialReactionEmoji`
+ :type emoji: :class:`PartialEmoji`
:param int message_id: The message ID of the message being un-reacted.
:param int channel_id: The channel ID where the message belongs to.
:param int user_id: The user ID of the user who removed the reaction.
@@ -1888,10 +1888,10 @@ Emoji
.. autoclass:: Emoji()
:members:
-PartialReactionEmoji
+PartialEmoji
~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: PartialReactionEmoji()
+.. autoclass:: PartialEmoji()
:members:
Role
diff --git a/docs/ext/commands/api.rst b/docs/ext/commands/api.rst
index 9fae2355..0f61be2f 100644
--- a/docs/ext/commands/api.rst
+++ b/docs/ext/commands/api.rst
@@ -173,6 +173,9 @@ Converters
.. autoclass:: discord.ext.commands.EmojiConverter
:members:
+.. autoclass:: discord.ext.commands.PartialEmojiConverter
+ :members:
+
.. autoclass:: discord.ext.commands.clean_content
:members:
diff --git a/docs/ext/commands/commands.rst b/docs/ext/commands/commands.rst
index d1957438..336ed5de 100644
--- a/docs/ext/commands/commands.rst
+++ b/docs/ext/commands/commands.rst
@@ -310,6 +310,7 @@ A lot of discord models work out of the gate as a parameter:
- :class:`Invite`
- :class:`Game`
- :class:`Emoji`
+- :class:`PartialEmoji`
- :class:`Colour`
Having any of these set as the converter will intelligently convert the argument to the appropriate target type you
@@ -339,6 +340,8 @@ converter is given below:
+-----------------------+-------------------------------------------------+
| :class:`Emoji` | :class:`~ext.commands.EmojiConverter` |
+-----------------------+-------------------------------------------------+
+| :class:`PartialEmoji` | :class:`~ext.commands.PartialEmojiConverter` |
++-----------------------+-------------------------------------------------+
| :class:`Colour` | :class:`~ext.commands.ColourConverter` |
+-----------------------+-------------------------------------------------+