Add documentation on bot_check_once

This commit is contained in:
Jaime Garcia Jr 2020-07-23 12:19:10 -05:00
parent 2628949cda
commit 5813593d6e

View File

@ -296,6 +296,10 @@ class Cog(metaclass=CogMeta):
"""A special method that registers as a :meth:`.Bot.check_once`
check.
Note that when using this function, context sent from a group command
may only parse the parent command and not the subcommands due to it
being invoked once per :meth:`.Command.invoke` call.
This function **can** be a coroutine and must take a sole parameter,
``ctx``, to represent the :class:`.Context`.
"""