matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

[commands] Mention that dynamic_cooldown callable can return None

Browse Source
This commit is contained in:
Rapptz
2021-07-02 05:35:38 -04:00
parent 69c400d813
commit 982140b5f7
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
discord/ext/commands/core.py
View File

@@ -1947,7 +1947,8 @@ def dynamic_cooldown(cooldown, type=BucketType.default):
This differs from :func:`.cooldown` in that it takes a function that
accepts a single parameter of type :class:`.discord.Message` and must
return a :class:`.Cooldown`
return a :class:`.Cooldown` or ``None``. If ``None`` is returned then
that cooldown is effectively bypassed.
A cooldown allows a command to only be used a specific amount
of times in a specific time frame. These cooldowns can be based
@@ -1964,9 +1965,9 @@ def dynamic_cooldown(cooldown, type=BucketType.default):
Parameters
------------
cooldown: Callable[[:class:`.discord.Message`], :class:`.Cooldown`]
cooldown: Callable[[:class:`.discord.Message`], Optional[:class:`.Cooldown`]]
A function that takes a message and returns a cooldown that will
apply to this invocation
apply to this invocation or ``None`` if the cooldown should be bypassed.
type: :class:`.BucketType`
The type of cooldown to have.
"""