diff options
| author | Rapptz <[email protected]> | 2020-12-18 21:34:46 -0500 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2020-12-18 21:35:27 -0500 |
| commit | 17b49c5a466cdb6d434ba69468a7c44e519cd676 (patch) | |
| tree | 85e27ea19e08c36ac990f71ec36ba5e796da03ed /docs/ext/commands | |
| parent | Add missing attributetable to new classes (diff) | |
| download | discord.py-17b49c5a466cdb6d434ba69468a7c44e519cd676.tar.xz discord.py-17b49c5a466cdb6d434ba69468a7c44e519cd676.zip | |
[commands] Make documentation use new attributetable
Diffstat (limited to 'docs/ext/commands')
| -rw-r--r-- | docs/ext/commands/api.rst | 71 |
1 files changed, 67 insertions, 4 deletions
diff --git a/docs/ext/commands/api.rst b/docs/ext/commands/api.rst index 5d6742a5..f97af13c 100644 --- a/docs/ext/commands/api.rst +++ b/docs/ext/commands/api.rst @@ -7,16 +7,29 @@ The following section outlines the API of discord.py's command extension module. .. _ext_commands_api_bot: +Bots +------ + Bot ----- +~~~~ + +.. attributetable:: discord.ext.commands.Bot .. autoclass:: discord.ext.commands.Bot :members: :inherited-members: +AutoShardedBot +~~~~~~~~~~~~~~~~ + +.. attributetable:: discord.ext.commands.AutoShardedBot + .. autoclass:: discord.ext.commands.AutoShardedBot :members: +Prefix Helpers +---------------- + .. autofunction:: discord.ext.commands.when_mentioned .. autofunction:: discord.ext.commands.when_mentioned_or @@ -64,21 +77,39 @@ are custom to the command extension module. .. _ext_commands_api_command: -Command --------- +Commands +---------- + +Decorators +~~~~~~~~~~~~ .. autofunction:: discord.ext.commands.command .. autofunction:: discord.ext.commands.group +Command +~~~~~~~~~ + +.. attributetable:: discord.ext.commands.Command + .. autoclass:: discord.ext.commands.Command :members: :special-members: __call__ +Group +~~~~~~ + +.. attributetable:: discord.ext.commands.Group + .. autoclass:: discord.ext.commands.Group :members: :inherited-members: +GroupMixin +~~~~~~~~~~~ + +.. attributetable:: discord.ext.commands.GroupMixin + .. autoclass:: discord.ext.commands.GroupMixin :members: @@ -87,28 +118,58 @@ Command Cogs ------ +Cog +~~~~ + +.. attributetable:: discord.ext.commands.Cog + .. autoclass:: discord.ext.commands.Cog :members: +CogMeta +~~~~~~~~ + +.. attributetable:: discord.ext.commands.CogMeta + .. autoclass:: discord.ext.commands.CogMeta :members: .. _ext_commands_help_command: Help Commands ------------------ +--------------- + +HelpCommand +~~~~~~~~~~~~ + +.. attributetable:: discord.ext.commands.HelpCommand .. autoclass:: discord.ext.commands.HelpCommand :members: +DefaultHelpCommand +~~~~~~~~~~~~~~~~~~~ + +.. attributetable:: discord.ext.commands.DefaultHelpCommand + .. autoclass:: discord.ext.commands.DefaultHelpCommand :members: :exclude-members: send_bot_help, send_cog_help, send_group_help, send_command_help, prepare_help_command +MinimalHelpCommand +~~~~~~~~~~~~~~~~~~~ + +.. attributetable:: discord.ext.commands.MinimalHelpCommand + .. autoclass:: discord.ext.commands.MinimalHelpCommand :members: :exclude-members: send_bot_help, send_cog_help, send_group_help, send_command_help, prepare_help_command +Paginator +~~~~~~~~~~ + +.. attributetable:: discord.ext.commands.Paginator + .. autoclass:: discord.ext.commands.Paginator :members: @@ -190,6 +251,8 @@ Checks Context -------- +.. attributetable:: discord.ext.commands.Context + .. autoclass:: discord.ext.commands.Context :members: :inherited-members: |