diff options
| author | Rapptz <[email protected]> | 2021-04-19 10:25:08 -0400 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2021-04-19 10:25:08 -0400 |
| commit | ddb71e2aedf081c3d261a992c30b345f3e38baf5 (patch) | |
| tree | bd622f28198058756629f4def419f26a557822e0 /docs/ext/commands/api.rst | |
| parent | Remove lingering User.avatar documentation (diff) | |
| download | discord.py-ddb71e2aedf081c3d261a992c30b345f3e38baf5.tar.xz discord.py-ddb71e2aedf081c3d261a992c30b345f3e38baf5.zip | |
[commands] Initial support for FlagConverter
The name is currently pending and there's no command.signature hook
for it yet since this requires bikeshedding.
Diffstat (limited to 'docs/ext/commands/api.rst')
| -rw-r--r-- | docs/ext/commands/api.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/ext/commands/api.rst b/docs/ext/commands/api.rst index b8ef64cf..2ccf7936 100644 --- a/docs/ext/commands/api.rst +++ b/docs/ext/commands/api.rst @@ -331,6 +331,17 @@ Converters .. autofunction:: discord.ext.commands.run_converters +Flag Converter +~~~~~~~~~~~~~~~ + +.. autoclass:: discord.ext.commands.FlagConverter + :members: + +.. autoclass:: discord.ext.commands.Flag() + :members: + +.. autofunction:: discord.ext.commands.flag + .. _ext_commands_api_errors: Exceptions @@ -456,6 +467,18 @@ Exceptions .. autoexception:: discord.ext.commands.NSFWChannelRequired :members: +.. autoexception:: discord.ext.commands.BadFlagArgument + :members: + +.. autoexception:: discord.ext.commands.MissingFlagArgument + :members: + +.. autoexception:: discord.ext.commands.TooManyFlags + :members: + +.. autoexception:: discord.ext.commands.MissingRequiredFlag + :members: + .. autoexception:: discord.ext.commands.ExtensionError :members: @@ -501,6 +524,10 @@ Exception Hierarchy - :exc:`~.commands.EmojiNotFound` - :exc:`~.commands.PartialEmojiConversionFailure` - :exc:`~.commands.BadBoolArgument` + - :exc:`~.commands.BadFlagArgument` + - :exc:`~.commands.MissingFlagArgument` + - :exc:`~.commands.TooManyFlags` + - :exc:`~.commands.MissingRequiredFlag` - :exc:`~.commands.BadUnionArgument` - :exc:`~.commands.ArgumentParsingError` - :exc:`~.commands.UnexpectedQuoteError` |