mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-09-03 00:25:14 +00:00
Code Issues Projects Releases Wiki Activity

[commands] Change FlagConverter to always raise BadFlagArgument

Browse Source
This commit is contained in:
z03h
2022-05-16 12:31:18 -07:00
committed by GitHub
parent 7267d18d9e
commit 9450a8e972
3 changed files with 18 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/ext/commands/commands.rst
View File

@ -798,6 +798,10 @@ In order to customise the flag syntax we also have a few options that can be pas
a command line parser. The syntax is mainly inspired by Discord's search bar input and as a result
all flags need a corresponding value.
Flag converters will only raise :exc:`~ext.commands.FlagError` derived exceptions. If an error is raised while
converting a flag, :exc:`~ext.commands.BadFlagArgument` is raised instead and the original exception
can be accessed with the :attr:`~ext.commands.BadFlagArgument.original` attribute.
The flag converter is similar to regular commands and allows you to use most types of converters
(with the exception of :class:`~ext.commands.Greedy`) as the type annotation. Some extra support is added for specific
annotations as described below.