diff options
| author | Rapptz <[email protected]> | 2020-01-18 19:57:47 -0500 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2020-01-18 20:04:00 -0500 |
| commit | a2b241446ed36cb848b5eb0c3a7a5d96ba4939ff (patch) | |
| tree | eea9df884de9cc5d679ec1e9324197d0b92b1789 /docs/ext | |
| parent | [commands] Context.send_help properly sends to on_help_command_error (diff) | |
| download | discord.py-a2b241446ed36cb848b5eb0c3a7a5d96ba4939ff.tar.xz discord.py-a2b241446ed36cb848b5eb0c3a7a5d96ba4939ff.zip | |
[commands] Document BucketType separately
Diffstat (limited to 'docs/ext')
| -rw-r--r-- | docs/ext/commands/api.rst | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/ext/commands/api.rst b/docs/ext/commands/api.rst index d16cb805..a8f7e001 100644 --- a/docs/ext/commands/api.rst +++ b/docs/ext/commands/api.rst @@ -111,6 +111,38 @@ Help Commands .. autoclass:: discord.ext.commands.Paginator :members: +Enums +------ + +.. class:: discord.ext.commands.BucketType + + Specifies a type of bucket for, e.g. a cooldown. + + .. attribute:: default + + The default bucket operates on a global basis. + .. attribute:: user + + The user bucket operates on a per-user basis. + .. attribute:: guild + + The guild bucket operates on a per-guild basis. + .. attribute:: channel + + The channel bucket operates on a per-channel basis. + .. attribute:: member + + The member bucket operates on a per-member basis. + .. attribute:: category + + The category bucket operates on a per-category basis. + .. attribute:: role + + The role bucket operates on a per-role basis. + + .. versionadded:: 1.3.0 + + .. _ext_commands_api_checks: Checks |