Added docs

Author: eunwoo1104

discord_slash/cog_ext.py

@@ -8,6 +8,47 @@ def cog_slash(*,
               auto_convert: dict = None,
               guild_ids: typing.List[int] = None,
               options: typing.List[dict] = None):
+    """
+    Decorator for Cog to add slash command.\n
+    Almost same as :func:`.client.SlashCommand.slash`.
+
+    Example:
+    .. code-block:: python
+
+        class ExampleCog(commands.Cog):
+            def __init__(self, bot):
+                if not hasattr(bot, "slash"):
+                    # Creates new SlashCommand instance to bot if bot doesn't have.
+                    bot.slash = SlashCommand(bot, override_type=True)
+                self.bot = bot
+                self.bot.slash.get_cog_commands(self)
+
+            def cog_unload(self):
+                self.bot.slash.remove_cog_commands(self)
+
+            @cog_ext.cog_slash(name="ping")
+            async def ping(self, ctx: SlashContext):
+                await ctx.send(content="Pong!")
+
+    :param name: Name of the slash command. Default name of the coroutine.
+    :type name: str
+    :param description: Description of the slash command. Default ``None``.
+    :type description: str
+    :param auto_convert: Dictionary of how to convert option values. Default ``None``.
+    :type auto_convert: dict
+    :param guild_ids: List of Guild ID of where the command will be used. Default ``None``, which will be global command.
+    :type guild_ids: List[int]
+    :param options: Options of the slash command. This will affect ``auto_convert`` and command data at Discord API. Default ``None``.
+    :type options: List[dict]
+    """
+    if options:
+        # Overrides original auto_convert.
+        auto_convert = {}
+        for x in options:
+            if x["type"] < 3:
+                raise Exception("Please use `cog_subcommand()` decorator for cog subcommands!")
+            auto_convert[x["name"]] = x["type"]
+
     def wrapper(cmd):
         _cmd = {
             "func": cmd,
@@ -28,6 +69,41 @@ def cog_subcommand(*,
                    description: str = None,
                    auto_convert: dict = None,
                    guild_ids: typing.List[int] = None):
+    """
+    Decorator for Cog to add subcommand.\n
+    Almost same as :func:`.client.SlashCommand.subcommand`.
+
+    Example:
+    .. code-block:: python
+
+        class ExampleCog(commands.Cog):
+            def __init__(self, bot):
+                if not hasattr(bot, "slash"):
+                    # Creates new SlashCommand instance to bot if bot doesn't have.
+                    bot.slash = SlashCommand(bot, override_type=True)
+                self.bot = bot
+                self.bot.slash.get_cog_commands(self)
+
+            def cog_unload(self):
+                self.bot.slash.remove_cog_commands(self)
+
+            @cog_ext.cog_subcommand(base="group", name="say")
+            async def group_say(self, ctx: SlashContext, text: str):
+                await ctx.send(content=text)
+
+    :param base: Name of the base command.
+    :type base: str
+    :param subcommand_group: Name of the subcommand group, if any. Default ``None`` which represents there is no sub group.
+    :type subcommand_group: str
+    :param name: Name of the subcommand. Default name of the coroutine.
+    :type name: str
+    :param description: Description of the subcommand. Default ``None``.
+    :type description: str
+    :param auto_convert: Dictionary of how to convert option values. Default ``None``.
+    :type auto_convert: dict
+    :param guild_ids: List of guild ID of where the command will be used. Default ``None``, which will be global command.
+    :type guild_ids: List[int]
+    """
     def wrapper(cmd):
         _sub = {
             "func": cmd,

discord_slash/model.py

@@ -171,21 +171,53 @@ async def delete(self, message_id: typing.Union[int, str] = "@original"):
 
 
 class CommandObject:
-    def __init__(self, name, cmd, *subcommands): # Let's reuse old command formatting.
+    """
+    Slash command object of this extension.
+
+    .. warning::
+        Do not manually init this model.
+
+    :ivar name: Name of the command.
+    :ivar func: The coroutine of the command.
+    :ivar description: Description of the command.
+    :ivar auto_convert: Dictionary of the `auto_convert` of the command.
+    :ivar allowed_guild_ids: List of the allowed guild id.
+    :ivar options: List of the option of the command. Used for `auto_register`.
+    """
+    def __init__(self, name, cmd): # Let's reuse old command formatting.
         self.name = name
         self.func = cmd["func"]
         self.description = cmd["description"]
         self.auto_convert = cmd["auto_convert"]
         self.allowed_guild_ids = cmd["guild_ids"]
         self.options = cmd["api_options"]
         self.has_subcommands = cmd["has_subcommands"]
-        self.subcommands = subcommands
 
     def invoke(self, *args):
+        """
+        Invokes the command.
+
+        :param args: Args for the command.
+        :return: Coroutine
+        """
         return self.func(*args)
 
 
 class SubcommandObject:
+    """
+    Subcommand object of this extension.
+
+    .. warning::
+        Do not manually init this model.
+
+    :ivar base: Name of the base slash command.
+    :ivar subcommand_group: Name of the subcommand group. ``None`` if not exist.
+    :ivar name: Name of the subcommand.
+    :ivar func: The coroutine of the command.
+    :ivar description: Description of the command.
+    :ivar auto_convert: Dictionary of the `auto_convert` of the command.
+    :ivar allowed_guild_ids: List of the allowed guild id.
+    """
     def __init__(self, sub, base, name, sub_group=None):
         self.base = base
         self.subcommand_group = sub_group
@@ -196,22 +228,52 @@ def __init__(self, sub, base, name, sub_group=None):
         self.allowed_guild_ids = sub["guild_ids"]
 
     def invoke(self, *args):
+        """
+        Invokes the command.
+
+        :param args: Args for the command.
+        :return: Coroutine
+        """
         return self.func(*args)
 
 
 class CogCommandObject(CommandObject):
+    """
+    Slash command object but for Cog.
+
+    .. warning::
+        Do not manually init this model.
+    """
     def __init__(self, *args):
         super().__init__(*args)
         self.cog = None # Manually set this later.
 
     def invoke(self, *args):
+        """
+        Invokes the command.
+
+        :param args: Args for the command.
+        :return: Coroutine
+        """
         return self.func(self.cog, *args)
 
 
 class CogSubcommandObject(SubcommandObject):
+    """
+    Subcommand object but for Cog.
+
+    .. warning::
+        Do not manually init this model.
+        """
     def __init__(self, *args):
         super().__init__(*args)
         self.cog = None # Manually set this later.
 
     def invoke(self, *args):
+        """
+        Invokes the command.
+
+        :param args: Args for the command.
+        :return: Coroutine
+        """
         return self.func(self.cog, *args)