diff options
| author | ToxicKidz <[email protected]> | 2021-07-07 20:15:18 -0400 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-07-07 20:15:18 -0400 |
| commit | 3cb539d91b600b5dcfe36ae1fe0acb6705ac232e (patch) | |
| tree | 808b1c59bc36c1867994c95e4f52544d2ee180f9 /docs | |
| parent | [commands] Add ThreadConverter (diff) | |
| download | discord.py-3cb539d91b600b5dcfe36ae1fe0acb6705ac232e.tar.xz discord.py-3cb539d91b600b5dcfe36ae1fe0acb6705ac232e.zip | |
[commands] Document the thread converter
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ext/commands/api.rst | 7 | ||||
| -rw-r--r-- | docs/ext/commands/commands.rst | 3 |
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/ext/commands/api.rst b/docs/ext/commands/api.rst index 0b999226..437e894a 100644 --- a/docs/ext/commands/api.rst +++ b/docs/ext/commands/api.rst @@ -405,6 +405,9 @@ Converters .. autoclass:: discord.ext.commands.PartialEmojiConverter :members: +.. autoclass:: discord.ext.commands.ThreadConverter + :members: + .. autoclass:: discord.ext.commands.clean_content :members: @@ -512,6 +515,9 @@ Exceptions .. autoexception:: discord.ext.commands.ChannelNotReadable :members: +.. autoexception:: discord.ext.commands.ThreadNotFound + :members: + .. autoexception:: discord.ext.commands.BadColourArgument :members: @@ -611,6 +617,7 @@ Exception Hierarchy - :exc:`~.commands.EmojiNotFound` - :exc:`~.commands.PartialEmojiConversionFailure` - :exc:`~.commands.BadBoolArgument` + - :exc:`~.commands.ThreadNotFound` - :exc:`~.commands.FlagError` - :exc:`~.commands.BadFlagArgument` - :exc:`~.commands.MissingFlagArgument` diff --git a/docs/ext/commands/commands.rst b/docs/ext/commands/commands.rst index e6d37c89..caa848b3 100644 --- a/docs/ext/commands/commands.rst +++ b/docs/ext/commands/commands.rst @@ -392,6 +392,7 @@ A lot of discord models work out of the gate as a parameter: - :class:`Colour` - :class:`Emoji` - :class:`PartialEmoji` +- :class:`Thread` (since v2.0) Having any of these set as the converter will intelligently convert the argument to the appropriate target type you specify. @@ -438,6 +439,8 @@ converter is given below: +--------------------------+-------------------------------------------------+ | :class:`PartialEmoji` | :class:`~ext.commands.PartialEmojiConverter` | +--------------------------+-------------------------------------------------+ +| :class:`Thread` | :class:`~ext.commands.ThreadConverter` | ++--------------------------+-------------------------------------------------+ By providing the converter it allows us to use them as building blocks for another converter: |