✨ Command groups

docs/api/commands.rst

@@ -42,15 +42,23 @@ Message Components
 
 .. autoclass:: ActionRow()
 .. autoclass:: Button()
+    :inherited-members:
 .. autoclass:: LinkButton()
 .. autoclass:: ButtonStyle()
 .. autoclass:: SelectMenu()
+    :inherited-members:
 .. autoclass:: SelectOption()
-.. autoclass:: _Component()
 
 .. autofunction:: button
     :decorator:
 .. autofunction:: select_menu
     :decorator:
 .. autofunction:: component
     :decorator:
+
+Command Groups
+~~~~~~~~~~~~~~
+.. currentmodule:: pincer.commands.groups
+
+.. autoclass:: Group()
+.. autoclass:: Subgroup()

docs/api/core.rst

@@ -18,24 +18,12 @@ GatewayDispatch
 Gateway
 -------
 
-Dispatcher
+Gateway
 ~~~~~~~~~~
 
-.. attributetable:: Dispatcher
-
-.. autoclass:: Dispatcher()
-    :exclude-members: __handler_manager, __dispatcher
-
-Heartbeat
----------
-
-Heartbeat
-~~~~~~~~~
-
-.. attributetable:: Heartbeat
+.. attributetable:: Gateway
 
-.. autoclass:: Heartbeat()
-    :exclude-members: __send
+.. autoclass:: Gateway()
 
 Http
 ----

docs/api/objects/guild.rst

@@ -199,13 +199,6 @@ InviteStageInstance
 
 .. autoclass:: InviteStageInstance()
 
-InviteMetadata
-~~~~~~~~~~~~~~
-
-.. attributetable:: InviteMetadata
-
-.. autoclass:: InviteMetadata()
-
 Invite
 ~~~~~~
 

docs/api/pincer.rst

@@ -20,6 +20,8 @@ Client
 Exceptions
 ----------
 
+.. currentmodule:: pincer.exceptions
+
 .. autoexception:: PincerError()
 
 .. autoexception:: InvalidPayload()

docs/interactions.rst

@@ -410,3 +410,68 @@ You can also dynamically set the selectable options.
     @select_menu
     async def select_menu(values: List[str]):
       return f"{values[0]} selected"
+
+
+Subcommands and Subcommand Groups
+---------------------------------
+To nest commands, Pincer organizes them into :class:`~pincer.commands.groups.Group` and
+:class:`~pincer.commands.groups.Subgroup` objects. Group and Subgroup names must only consist of
+lowercase letters and underscores.
+
+
+This chart shows the organization of nested commands:
+
+.. code-block::
+
+  If you use a group:
+
+  group name
+    command name
+
+  If you use a group and sub group:
+
+  group name
+    subgroup name
+      command name
+
+  Organizing commands like this is also valid:
+
+  group name
+    subgroup name
+      command name
+    command name
+
+:class:`~pincer.commands.groups.Group` and :class:`~pincer.commands.groups.Subgroup` are set to the parent in a @command
+decorator to nest a command inside of them. They are not available for User Commands and Message Commands.
+
+.. code-block:: python
+
+  from pincer.commands import Group, Subgroup
+  ...
+
+  class Bot(Client):
+
+    command_group = Group("command_group")
+    command_sub_group = Subgroup("command_sub_group", parent=a_command_group)
+
+    @command(parent=command_group)
+    def command_group_command():
+      pass
+
+    @command(parent=command_sub_group)
+    def command_sub_group_command():
+      pass
+
+    # Creating these commands is valid because there is no top-level command or group
+    # with the same name.
+    @command
+    def command_group_command():
+      pass
+    @command
+    def command_sub_group():
+      pass
+
+    # This command is not valid because there is a group with the same name.
+    @command
+    def a_command_group():
+      pass

pincer/commands/__init__.py

@@ -1,14 +1,7 @@
 # Copyright Pincer 2021-Present
 # Full MIT License can be found in `LICENSE` at the project root.
 
-from .commands import (
-    command,
-    user_command,
-    message_command,
-    ChatCommandHandler,
-    hash_app_command,
-    hash_app_command_params,
-)
+from .commands import command, user_command, message_command, ChatCommandHandler
 from .arg_types import (
     CommandArg,
     Description,
@@ -23,12 +16,13 @@
     ActionRow, Button, ButtonStyle, ComponentHandler, SelectMenu, SelectOption,
     component, button, select_menu, LinkButton
 )
+from .groups import Group, Subgroup
 
 __all__ = (
     "ActionRow", "Button", "ButtonStyle", "ChannelTypes",
     "ChatCommandHandler", "Choice", "Choices", "CommandArg",
     "ComponentHandler", "Description", "LinkButton", "MaxValue", "MinValue",
     "Modifier", "SelectMenu", "SelectOption", "button", "command", "component",
-    "hash_app_command", "hash_app_command_params", "message_command",
-    "select_menu", "user_command"
+    "message_command",
+    "select_menu", "user_command", "Group", "Subgroup"
 )