diff options
| author | Josh <[email protected]> | 2021-05-06 21:51:07 +1000 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-05-06 07:51:07 -0400 |
| commit | 3864fb37a0814345913c7ca4fd1978fa5e2ef7e2 (patch) | |
| tree | e5a411b6e35fe3485381880a40223cc574d5e2e9 /docs/ext | |
| parent | Typehint emoji classes (diff) | |
| download | discord.py-3864fb37a0814345913c7ca4fd1978fa5e2ef7e2.tar.xz discord.py-3864fb37a0814345913c7ca4fd1978fa5e2ef7e2.zip | |
Fix various reference issues in documentation
Co-Authored-By: Riley Shaw <[email protected]>
Diffstat (limited to 'docs/ext')
| -rw-r--r-- | docs/ext/commands/api.rst | 10 | ||||
| -rw-r--r-- | docs/ext/commands/commands.rst | 2 |
2 files changed, 8 insertions, 4 deletions
diff --git a/docs/ext/commands/api.rst b/docs/ext/commands/api.rst index 9cd655b4..aa31a000 100644 --- a/docs/ext/commands/api.rst +++ b/docs/ext/commands/api.rst @@ -42,7 +42,7 @@ Event Reference These events function similar to :ref:`the regular events <discord-api-events>`, except they are custom to the command extension module. -.. function:: on_command_error(ctx, error) +.. function:: discord.ext.commands.on_command_error(ctx, error) An error handler that is called when an error is raised inside a command either through user input error, check @@ -55,7 +55,7 @@ are custom to the command extension module. :param error: The error that was raised. :type error: :class:`.CommandError` derived -.. function:: on_command(ctx) +.. function:: discord.ext.commands.on_command(ctx) An event that is called when a command is found and is about to be invoked. @@ -65,7 +65,7 @@ are custom to the command extension module. :param ctx: The invocation context. :type ctx: :class:`.Context` -.. function:: on_command_completion(ctx) +.. function:: discord.ext.commands.on_command_completion(ctx) An event that is called when a command has completed its invocation. @@ -374,6 +374,9 @@ Exceptions .. autoexception:: discord.ext.commands.BadUnionArgument :members: +.. autoexception:: discord.ext.commands.BadLiteralArgument + :members: + .. autoexception:: discord.ext.commands.PrivateMessageOnly :members: @@ -533,6 +536,7 @@ Exception Hierarchy - :exc:`~.commands.TooManyFlags` - :exc:`~.commands.MissingRequiredFlag` - :exc:`~.commands.BadUnionArgument` + - :exc:`~.commands.BadLiteralArgument` - :exc:`~.commands.ArgumentParsingError` - :exc:`~.commands.UnexpectedQuoteError` - :exc:`~.commands.InvalidEndOfQuotedStringError` diff --git a/docs/ext/commands/commands.rst b/docs/ext/commands/commands.rst index a5f8998b..6e1f4223 100644 --- a/docs/ext/commands/commands.rst +++ b/docs/ext/commands/commands.rst @@ -761,7 +761,7 @@ When our commands fail to parse we will, by default, receive a noisy error in `` that an error has happened and has been silently ignored. In order to handle our errors, we must use something called an error handler. There is a global error handler, called -:func:`on_command_error` which works like any other event in the :ref:`discord-api-events`. This global error handler is +:func:`.on_command_error` which works like any other event in the :ref:`discord-api-events`. This global error handler is called for every error reached. Most of the time however, we want to handle an error local to the command itself. Luckily, commands come with local error |