From bda3afcad74bb03e604902e415076bcb4aac3ff2 Mon Sep 17 00:00:00 2001 From: Shun Tannai <1ntegrale9uation@gmail.com> Date: Wed, 7 Apr 2021 16:20:35 +0900 Subject: [PATCH] [commands] Update Converter list in ext.commands introduction --- docs/ext/commands/commands.rst | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/docs/ext/commands/commands.rst b/docs/ext/commands/commands.rst index 235e63ce8..8746a1505 100644 --- a/docs/ext/commands/commands.rst +++ b/docs/ext/commands/commands.rst @@ -373,17 +373,19 @@ A lot of discord models work out of the gate as a parameter: - :class:`Member` - :class:`User` +- :class:`Message` (since v1.1) +- :class:`PartialMessage` (since v1.7) - :class:`TextChannel` - :class:`VoiceChannel` +- :class:`StoreChannel` (since v1.7) - :class:`CategoryChannel` -- :class:`Role` -- :class:`Message` (since v1.1) -- :class:`PartialMessage` (since v1.7) - :class:`Invite` +- :class:`Guild` (since v1.7) +- :class:`Role` - :class:`Game` +- :class:`Colour` - :class:`Emoji` - :class:`PartialEmoji` -- :class:`Colour` Having any of these set as the converter will intelligently convert the argument to the appropriate target type you specify. @@ -396,30 +398,34 @@ converter is given below: +--------------------------+-------------------------------------------------+ | :class:`Member` | :class:`~ext.commands.MemberConverter` | +--------------------------+-------------------------------------------------+ +| :class:`User` | :class:`~ext.commands.UserConverter` | ++--------------------------+-------------------------------------------------+ | :class:`Message` | :class:`~ext.commands.MessageConverter` | +--------------------------+-------------------------------------------------+ | :class:`PartialMessage` | :class:`~ext.commands.PartialMessageConverter` | +--------------------------+-------------------------------------------------+ -| :class:`User` | :class:`~ext.commands.UserConverter` | -+--------------------------+-------------------------------------------------+ | :class:`TextChannel` | :class:`~ext.commands.TextChannelConverter` | +--------------------------+-------------------------------------------------+ | :class:`VoiceChannel` | :class:`~ext.commands.VoiceChannelConverter` | +--------------------------+-------------------------------------------------+ -| :class:`CategoryChannel` | :class:`~ext.commands.CategoryChannelConverter` | +| :class:`StoreChannel` | :class:`~ext.commands.StoreChannelConverter` | +--------------------------+-------------------------------------------------+ -| :class:`Role` | :class:`~ext.commands.RoleConverter` | +| :class:`CategoryChannel` | :class:`~ext.commands.CategoryChannelConverter` | +--------------------------+-------------------------------------------------+ | :class:`Invite` | :class:`~ext.commands.InviteConverter` | +--------------------------+-------------------------------------------------+ +| :class:`Guild` | :class:`~ext.commands.GuildConverter` | ++--------------------------+-------------------------------------------------+ +| :class:`Role` | :class:`~ext.commands.RoleConverter` | ++--------------------------+-------------------------------------------------+ | :class:`Game` | :class:`~ext.commands.GameConverter` | +--------------------------+-------------------------------------------------+ +| :class:`Colour` | :class:`~ext.commands.ColourConverter` | ++--------------------------+-------------------------------------------------+ | :class:`Emoji` | :class:`~ext.commands.EmojiConverter` | +--------------------------+-------------------------------------------------+ | :class:`PartialEmoji` | :class:`~ext.commands.PartialEmojiConverter` | +--------------------------+-------------------------------------------------+ -| :class:`Colour` | :class:`~ext.commands.ColourConverter` | -+--------------------------+-------------------------------------------------+ By providing the converter it allows us to use them as building blocks for another converter: