Browse Source

[commands] Document the thread converter

pull/7190/head
ToxicKidz 4 years ago
committed by GitHub
parent
commit
3cb539d91b
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      discord/ext/commands/errors.py
  2. 7
      docs/ext/commands/api.rst
  3. 3
      docs/ext/commands/commands.rst

2
discord/ext/commands/errors.py

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

7
docs/ext/commands/api.rst

@ -405,6 +405,9 @@ Converters
.. autoclass:: discord.ext.commands.PartialEmojiConverter .. autoclass:: discord.ext.commands.PartialEmojiConverter
:members: :members:
.. autoclass:: discord.ext.commands.ThreadConverter
:members:
.. autoclass:: discord.ext.commands.clean_content .. autoclass:: discord.ext.commands.clean_content
:members: :members:
@ -512,6 +515,9 @@ Exceptions
.. autoexception:: discord.ext.commands.ChannelNotReadable .. autoexception:: discord.ext.commands.ChannelNotReadable
:members: :members:
.. autoexception:: discord.ext.commands.ThreadNotFound
:members:
.. autoexception:: discord.ext.commands.BadColourArgument .. autoexception:: discord.ext.commands.BadColourArgument
:members: :members:
@ -611,6 +617,7 @@ Exception Hierarchy
- :exc:`~.commands.EmojiNotFound` - :exc:`~.commands.EmojiNotFound`
- :exc:`~.commands.PartialEmojiConversionFailure` - :exc:`~.commands.PartialEmojiConversionFailure`
- :exc:`~.commands.BadBoolArgument` - :exc:`~.commands.BadBoolArgument`
- :exc:`~.commands.ThreadNotFound`
- :exc:`~.commands.FlagError` - :exc:`~.commands.FlagError`
- :exc:`~.commands.BadFlagArgument` - :exc:`~.commands.BadFlagArgument`
- :exc:`~.commands.MissingFlagArgument` - :exc:`~.commands.MissingFlagArgument`

3
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:`Colour`
- :class:`Emoji` - :class:`Emoji`
- :class:`PartialEmoji` - :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 Having any of these set as the converter will intelligently convert the argument to the appropriate target type you
specify. specify.
@ -438,6 +439,8 @@ converter is given below:
+--------------------------+-------------------------------------------------+ +--------------------------+-------------------------------------------------+
| :class:`PartialEmoji` | :class:`~ext.commands.PartialEmojiConverter` | | :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: By providing the converter it allows us to use them as building blocks for another converter:

Loading…
Cancel
Save