Rename client.SlashCommand http -> req, Updated docs

Author: eunwoo1104

discord_slash/__init__.py

@@ -12,4 +12,4 @@
 from .model import SlashContext
 from .utils import manage_commands
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"

discord_slash/client.py

@@ -12,6 +12,11 @@ class SlashCommand:
 
     :param client: discord.py Bot class. Although it accepts :class:`discord.Client` at init, using it is not allowed since :class:`discord.Client` doesn't support :func:`add_listener`.
     :type client: Union[discord.Client, discord.ext.commands.Bot]
+
+    :ivar _discord: Discord client of this client.
+    :ivar commands: Dictionary of the registered commands via :func:`.slash` decorator.
+    :ivar req: :class:`.http.SlashCommandRequest` of this client.
+    :ivar logger: Logger of this client.
     """
     def __init__(self,
                  client: typing.Union[discord.Client,
@@ -21,18 +26,38 @@ def __init__(self,
             raise Exception("Currently only commands.Bot is supported.")
         self._discord = client
         self.commands = {}
-        self.http = http.SlashCommandRequest()
+        self.req = http.SlashCommandRequest()
         self.logger = logging.getLogger("discord_slash")
         self._discord.add_listener(self.on_socket_response)
 
-    def slash(self, name=None):
+    def slash(self, name=None, auto_convert: dict = None):
         """
         Decorator that registers coroutine as a slash command.\n
-        1 arg is required for ctx(:func:`discord_slash.model.SlashContext`), and if your slash command has some args, then those args are also required.\n
-        All args are passed in order.\n
-        Note that Role, User, and Channel types are passed as id, since API doesn't give type of the option for now.
+        1 arg is required for ctx(:class:`.model.SlashContext`), and if your slash command has some args, then those args are also required.\n
+        All args are passed in order.
+
+        .. note::
+            Role, User, and Channel types are passed as id, since API doesn't give type of the option for now.
+
+        .. warning::
+            Unlike discord.py's command, ``*args``, keyword-only args, converters, etc. are NOT supported.
+
+        Example:
+
+        .. code-block:: python
+
+            @slash.slash(name="ping")
+            async def _slash(ctx): # Normal usage.
+                await ctx.send(text=f"Pong! (`{round(bot.latency*1000)}`ms)")
+
+
+            @slash.slash(name="pick")
+            async def _pick(ctx, choice1, choice2): # Command with 1 or more args.
+                await ctx.send(text=str(random.choice([choice1, choice2])))
 
         :param name: Name of the slash command.
+        :param auto_convert: Not implemented.
+        :type auto_convert: dict
         """
         def wrapper(cmd):
             self.commands[cmd.__name__ if not name else name] = cmd
@@ -57,8 +82,10 @@ def process_options(self, options: dict) -> list:
 
     async def on_socket_response(self, msg):
         """
-        This event listener is automatically registered at initialization of this class.\n
-        DO NOT MANUALLY REGISTER, OVERRIDE, OR WHATEVER ACTION TO THIS COROUTINE UNLESS YOU KNOW WHAT YOU ARE DOING.
+        This event listener is automatically registered at initialization of this class.
+
+        .. warning::
+            DO NOT MANUALLY REGISTER, OVERRIDE, OR WHATEVER ACTION TO THIS COROUTINE UNLESS YOU KNOW WHAT YOU ARE DOING.
 
         :param msg: Gateway message.
         """
@@ -67,5 +94,5 @@ async def on_socket_response(self, msg):
         to_use = msg["d"]
         if to_use["data"]["name"] in self.commands.keys():
             args = [x["value"] for x in to_use["data"]["options"]] if "options" in to_use["data"] else []
-            ctx = model.SlashContext(self.http, to_use, self._discord)
+            ctx = model.SlashContext(self.req, to_use, self._discord)
             await self.commands[to_use["data"]["name"]](ctx, *args)

discord_slash/error.py

@@ -9,6 +9,9 @@ class SlashCommandError(Exception):
 class RequestFailure(SlashCommandError):
     """
     Request to Discord API has failed.
+
+    :ivar status: Status code of failed response.
+    :ivar msg: Message of failed response.
     """
     def __init__(self, status: int, msg: str):
         self.status = status

discord_slash/http.py

@@ -15,7 +15,7 @@ async def post(self, _resp, _id, token):
         :param _id: Command message id.
         :param token: Command message token.
         :return: True if succeeded.
-        :raises: :class:`error.RequestFailure` - Requesting to API has failed.
+        :raises: :class:`.error.RequestFailure` - Requesting to API has failed.
         """
         req_url = f"https://discord.com/api/v8/interactions/{_id}/{token}/callback"
         async with aiohttp.ClientSession() as session:

discord_slash/model.py

@@ -8,6 +8,14 @@ class SlashContext:
     """
     Context of the slash command.\n
     Kinda similar with discord.ext.commands.Context.
+
+    :ivar name: Name of the command.
+    :ivar id: ID of the command message.
+    :ivar command_id: ID of the command.
+    :ivar _http: :class:`.http.SlashCommandRequest` of the client.
+    :ivar guild: :class:`discord.Guild` instance of the command message.
+    :ivar author: :class:`discord.Member` instance representing author of the command message.
+    :ivar channel: :class:`discord.TextChannel` instance representing channel of the command message.
     """
     def __init__(self,
                  _http: http.SlashCommandRequest,