Add revisions to check_once docs

This commit is contained in:
Jaime Garcia Jr 2020-07-24 09:18:42 -05:00
parent 5813593d6e
commit 1c3b0c02f8
2 changed files with 6 additions and 4 deletions

View File

@ -255,6 +255,12 @@ class BotBase(GroupMixin):
bypasses that and ensures that it's called only once, even inside bypasses that and ensures that it's called only once, even inside
the default help command. the default help command.
.. note::
When using this function the :class:`.Context` sent to a group subcommand
may only parse the parent command and not the subcommands due to it
being invoked once per :meth:`.Bot.invoke` call.
.. note:: .. note::
This function can either be a regular function or a coroutine. This function can either be a regular function or a coroutine.

View File

@ -296,10 +296,6 @@ class Cog(metaclass=CogMeta):
"""A special method that registers as a :meth:`.Bot.check_once` """A special method that registers as a :meth:`.Bot.check_once`
check. 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, This function **can** be a coroutine and must take a sole parameter,
``ctx``, to represent the :class:`.Context`. ``ctx``, to represent the :class:`.Context`.
""" """