Document on_error "special" behavior

This commit is contained in:
Vexs 2020-08-14 08:16:03 -05:00 committed by GitHub
parent 00d39704da
commit 8252b1f884
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -195,6 +195,14 @@ to handle it, which defaults to print a traceback and ignoring the exception.
:ref:`py:raise`. Exceptions raised by ``on_error`` will not be :ref:`py:raise`. Exceptions raised by ``on_error`` will not be
handled in any way by :class:`Client`. handled in any way by :class:`Client`.
.. note::
``on_error`` will only be dispatched to :meth:`Client.event`.
It will not be received by :meth:`Client.wait_for`, or, if used,
:ref:`ext_commands_api_bot` listeners such as
:meth:`~ext.commands.Bot.listen` or :meth:`~ext.commands.Cog.listener`.
:param event: The name of the event that raised the exception. :param event: The name of the event that raised the exception.
:type event: :class:`str` :type event: :class:`str`