diff options
| author | Shun Tannai <[email protected]> | 2021-04-07 16:20:35 +0900 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2021-04-15 08:57:45 -0400 |
| commit | 8b4d7f122c869db8fdc6bc68f71a8e00e26fbee0 (patch) | |
| tree | 0121bc7c8ee04d438fc987c44e2904812a09dfca | |
| parent | [docs] add note for possible Embed.type strings (diff) | |
| download | discord.py-8b4d7f122c869db8fdc6bc68f71a8e00e26fbee0.tar.xz discord.py-8b4d7f122c869db8fdc6bc68f71a8e00e26fbee0.zip | |
[commands] Update Converter list in ext.commands introduction
| -rw-r--r-- | docs/ext/commands/commands.rst | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/docs/ext/commands/commands.rst b/docs/ext/commands/commands.rst index ab1d4357..5e13425b 100644 --- a/docs/ext/commands/commands.rst +++ b/docs/ext/commands/commands.rst @@ -375,17 +375,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. @@ -398,30 +400,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: |