[commands] Document that cog_command_error must be async

This commit is contained in:
Xua 2020-05-08 21:48:44 +12:00 committed by Rapptz
parent 6e8d538f09
commit 4e6942194f

View File

@ -312,14 +312,14 @@ class Cog(metaclass=CogMeta):
return True return True
@_cog_special_method @_cog_special_method
def cog_command_error(self, ctx, error): async def cog_command_error(self, ctx, error):
"""A special method that is called whenever an error """A special method that is called whenever an error
is dispatched inside this cog. is dispatched inside this cog.
This is similar to :func:`.on_command_error` except only applying This is similar to :func:`.on_command_error` except only applying
to the commands inside this cog. to the commands inside this cog.
This function **can** be a coroutine. This **must** be a coroutine.
Parameters Parameters
----------- -----------