matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

[commands] Document the thread converter

Browse Source
This commit is contained in:
ToxicKidz 2021-07-07 20:15:18 -04:00 committed by GitHub
parent 5a7cfb3ce6
commit 3cb539d91b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
discord/ext/commands/errors.py
View File

@ -342,7 +342,7 @@ class ThreadNotFound(BadArgument):
This inherits from :exc:`BadArgument`
..versionadded:: 2.0
.. versionadded:: 2.0
Attributes
-----------

7
docs/ext/commands/api.rst
View File

@ -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`

3
docs/ext/commands/commands.rst
View File

@ -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: