Browse Source
[commands] Document the thread converter
pull/7190/head
ToxicKidz
4 years ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with
11 additions and
1 deletions
-
discord/ext/commands/errors.py
-
docs/ext/commands/api.rst
-
docs/ext/commands/commands.rst
|
|
|
@ -342,7 +342,7 @@ class ThreadNotFound(BadArgument): |
|
|
|
|
|
|
|
This inherits from :exc:`BadArgument` |
|
|
|
|
|
|
|
..versionadded:: 2.0 |
|
|
|
.. versionadded:: 2.0 |
|
|
|
|
|
|
|
Attributes |
|
|
|
----------- |
|
|
|
|
|
|
|
@ -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` |
|
|
|
|
|
|
|
@ -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: |
|
|
|
|
|
|
|
|
