Skip to content

Commit 93e7fcb

Browse files
committed
Add cooldown docs
1 parent c678175 commit 93e7fcb

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

docs/exts/commands/core.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Decorators
2626

2727
.. autofunction:: twitchio.ext.commands.group
2828

29+
.. autofunction:: twitchio.ext.commands.cooldown(*, base: BaseCooldown, rate: int, per: float, key: Callable[[Any], Hashable] | Callable[[Any], Coroutine[Any, Any, Hashable]] | BucketType, **kwargs: ~typing.Any)
30+
2931

3032
Guards
3133
######
@@ -44,3 +46,16 @@ Guards
4446

4547
.. autofunction:: twitchio.ext.commands.is_elevated
4648

49+
50+
Cooldowns
51+
#########
52+
53+
.. autoclass:: twitchio.ext.commands.BaseCooldown
54+
:members:
55+
56+
.. autoclass:: twitchio.ext.commands.Cooldown
57+
58+
.. autoclass:: twitchio.ext.commands.GCRACooldown
59+
60+
.. attributetable:: twitchio.ext.commands.BucketType()
61+
.. autoclass:: twitchio.ext.commands.BucketType()

docs/exts/commands/exceptions.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,6 @@ Exceptions
4747

4848
.. autoexception:: twitchio.ext.commands.ModuleNotLoadedError
4949

50-
.. autoexception:: twitchio.ext.commands.NoEntryPointError
50+
.. autoexception:: twitchio.ext.commands.NoEntryPointError
51+
52+
.. autoexception:: twitchio.ext.commands.CommandOnCooldown

0 commit comments

Comments
 (0)