aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2017-09-13 17:17:04 -0400
committerRapptz <[email protected]>2017-09-13 17:19:30 -0400
commite614f6b4cdc6280def19acfc0092fc5b95af48e1 (patch)
tree1ea41f257d9323bdcea0d9a7b008ce61b595b420 /docs
parentAdd Guild.create_category. (diff)
downloaddiscord.py-e614f6b4cdc6280def19acfc0092fc5b95af48e1.tar.xz
discord.py-e614f6b4cdc6280def19acfc0092fc5b95af48e1.zip
[commands] Add CategoryChannelConverter
Diffstat (limited to 'docs')
-rw-r--r--docs/ext/commands/api.rst9
-rw-r--r--docs/ext/commands/commands.rst45
2 files changed, 30 insertions, 24 deletions
diff --git a/docs/ext/commands/api.rst b/docs/ext/commands/api.rst
index 61ed0151..9fae2355 100644
--- a/docs/ext/commands/api.rst
+++ b/docs/ext/commands/api.rst
@@ -152,6 +152,12 @@ Converters
.. autoclass:: discord.ext.commands.TextChannelConverter
:members:
+.. autoclass:: discord.ext.commands.VoiceChannelConverter
+ :members:
+
+.. autoclass:: discord.ext.commands.CategoryChannelConverter
+ :members:
+
.. autoclass:: discord.ext.commands.InviteConverter
:members:
@@ -164,9 +170,6 @@ Converters
.. autoclass:: discord.ext.commands.ColourConverter
:members:
-.. autoclass:: discord.ext.commands.VoiceChannelConverter
- :members:
-
.. autoclass:: discord.ext.commands.EmojiConverter
:members:
diff --git a/docs/ext/commands/commands.rst b/docs/ext/commands/commands.rst
index 83371add..dc8d7e73 100644
--- a/docs/ext/commands/commands.rst
+++ b/docs/ext/commands/commands.rst
@@ -305,6 +305,7 @@ A lot of discord models work out of the gate as a parameter:
- :class:`User`
- :class:`TextChannel`
- :class:`VoiceChannel`
+- :class:`CategoryChannel`
- :class:`Role`
- :class:`Invite`
- :class:`Game`
@@ -317,27 +318,29 @@ specify.
Under the hood, these are implemented by the :ref:`ext_commands_adv_converters` interface. A table of the equivalent
converter is given below:
-+-----------------------+----------------------------------------------+
-| Discord Class | Converter |
-+-----------------------+----------------------------------------------+
-| :class:`Member` | :class:`~ext.commands.MemberConverter` |
-+-----------------------+----------------------------------------------+
-| :class:`User` | :class:`~ext.commands.UserConverter` |
-+-----------------------+----------------------------------------------+
-| :class:`TextChannel` | :class:`~ext.commands.TextChannelConverter` |
-+-----------------------+----------------------------------------------+
-| :class:`VoiceChannel` | :class:`~ext.commands.VoiceChannelConverter` |
-+-----------------------+----------------------------------------------+
-| :class:`Role` | :class:`~ext.commands.RoleConverter` |
-+-----------------------+----------------------------------------------+
-| :class:`Invite` | :class:`~ext.commands.InviteConverter` |
-+-----------------------+----------------------------------------------+
-| :class:`Game` | :class:`~ext.commands.GameConverter` |
-+-----------------------+----------------------------------------------+
-| :class:`Emoji` | :class:`~ext.commands.EmojiConverter` |
-+-----------------------+----------------------------------------------+
-| :class:`Colour` | :class:`~ext.commands.ColourConverter` |
-+-----------------------+----------------------------------------------+
++-----------------------+-------------------------------------------------+
+| Discord Class | Converter |
++-----------------------+-------------------------------------------------+
+| :class:`Member` | :class:`~ext.commands.MemberConverter` |
++-----------------------+-------------------------------------------------+
+| :class:`User` | :class:`~ext.commands.UserConverter` |
++-----------------------+-------------------------------------------------+
+| :class:`TextChannel` | :class:`~ext.commands.TextChannelConverter` |
++-----------------------+-------------------------------------------------+
+| :class:`VoiceChannel` | :class:`~ext.commands.VoiceChannelConverter` |
++-----------------------+-------------------------------------------------+
+| :class:`VoiceChannel` | :class:`~ext.commands.CategoryChannelConverter` |
++-----------------------+-------------------------------------------------+
+| :class:`Role` | :class:`~ext.commands.RoleConverter` |
++-----------------------+-------------------------------------------------+
+| :class:`Invite` | :class:`~ext.commands.InviteConverter` |
++-----------------------+-------------------------------------------------+
+| :class:`Game` | :class:`~ext.commands.GameConverter` |
++-----------------------+-------------------------------------------------+
+| :class:`Emoji` | :class:`~ext.commands.EmojiConverter` |
++-----------------------+-------------------------------------------------+
+| :class:`Colour` | :class:`~ext.commands.ColourConverter` |
++-----------------------+-------------------------------------------------+
By providing the converter it allows us to use them as building blocks for another converter: