interactions-py · EepyElvyra · Nov 9, 2022 · Oct 4, 2022 · Oct 4, 2022 · Oct 4, 2022
diff --git a/docs/api.cache.rst b/docs/api.cache.rst
diff --git a/docs/api.dispatch.rst b/docs/api.dispatch.rst
diff --git a/docs/api.enums.rst b/docs/api.enums.rst
diff --git a/docs/api.error.rst b/docs/api.error.rst
diff --git a/docs/api.gateway.rst b/docs/api.gateway.rst
diff --git a/docs/api.http.rst b/docs/api.http.rst
@@ -3,50 +3,23 @@
 HTTP
 ====
 
+.. important::
+    This page shows internal functions that you should not use unless you know how to use them.
+    Most of these functions should have their own implementation in the different Models of the library.
+
 .. autoclass:: interactions.api.http.route.Route
     :members:
+    :noindex:
 
 .. autoclass:: interactions.api.http.limiter.Limiter
     :members:
+    :noindex:
 
 .. autoclass:: interactions.api.http.request._Request
     :members:
+    :noindex:
 
 .. autoclass:: interactions.api.http.client.HTTPClient
     :members:
-
-.. autoclass:: interactions.api.http.channel.ChannelRequest
-    :members:
-
-.. autoclass:: interactions.api.http.emoji.EmojiRequest
-    :members:
-
-.. autoclass:: interactions.api.http.guild.GuildRequest
-    :members:
-
-.. autoclass:: interactions.api.http.interaction.InteractionRequest
-    :members:
-
-.. autoclass:: interactions.api.http.member.MemberRequest
-    :members:
-
-.. autoclass:: interactions.api.http.message.MessageRequest
-    :members:
-
-.. autoclass:: interactions.api.http.reaction.ReactionRequest
-    :members:
-
-.. autoclass:: interactions.api.http.scheduledEvent.ScheduledEventRequest
-    :members:
-
-.. autoclass:: interactions.api.http.sticker.StickerRequest
-    :members:
-
-.. autoclass:: interactions.api.http.thread.ThreadRequest
-    :members:
-
-.. autoclass:: interactions.api.http.user.UserRequest
-    :members:
-
-.. autoclass:: interactions.api.http.webhook.WebhookRequest
-    :members:
+    :inherited-members:
+    :noindex:
diff --git a/docs/api.models.rst b/docs/api.models.rst
@@ -1,6 +1,6 @@
 .. currentmodule:: interactions
 
-Model Objects
+API Models
 =============
 
 .. toctree::
@@ -20,3 +20,4 @@ Model Objects
     api.models.team.rst
     api.models.user.rst
     api.models.webhook.rst
+    enums.rst
diff --git a/docs/api.rst b/docs/api.rst
@@ -3,10 +3,7 @@
 API Reference
 =============
 
-This page outlines the API wrapper of discord-interactions.
-
-Interactions
-************
+This page outlines the API reference of interactions.py.
 
 .. toctree::
     :maxdepth: 2
@@ -16,40 +13,36 @@ Interactions
 
 .. toctree::
     :maxdepth: 2
-    :caption: Frameworks/Commands
+    :caption: API Models
 
-    ext.rst
-    context.rst
-    utils.rst
+    api.models.rst
 
 .. toctree::
     :maxdepth: 2
-    :caption: Model/Design
+    :caption: Commands & Components
 
     models.rst
-    enums.rst
-
-Discord API
-***********
 
 .. toctree::
     :maxdepth: 2
-    :caption: Client Connections
+    :caption: Context
 
-    api.gateway.rst
-    api.http.rst
+    context.rst
 
 .. toctree::
     :maxdepth: 2
-    :caption: Model/Design
+    :caption: Utilities
 
-    api.cache.rst
-    api.enums.rst
-    api.models.rst
+    utils.rst
 
 .. toctree::
-    :maxdepth: 2
-    :caption: Events
+    :maxdepth: 1
+    :caption: HTTP
+
+    api.http.rst
+
+.. toctree::
+    :maxdepth: 1
+    :caption: External Framework
 
-    api.dispatch.rst
-    api.error.rst
+    ext.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -78,7 +78,7 @@
 exclude_patterns = ["_build"]
 
 # This autodocs private attrs and also fixes wrong sort
-autodoc_default_options = {"member-order": "bysource", "private-members": True}
+autodoc_default_options = {"member-order": "bysource"}
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/context.rst b/docs/context.rst
@@ -4,5 +4,6 @@ Event Context
 =============
 
 .. automodule:: interactions.client.context
+    :inherited-members: ClientSerializerMixin
     :members:
-    :inherited-members:
+    :private-members:
diff --git a/docs/events.rst b/docs/events.rst
@@ -19,18 +19,18 @@ Generally, you can listen to an event like this:
 
     # possibility 1
     @bot.event
-    async def on_(...):
+    async def on_xxx(...):
         ...  # do smth
 
     # possibility 2
-    @bot.event(name="on_")
+    @bot.event(name="on_xxx")
     async def you_are_free_to_name_this_as_you_want(...):
         ... # do smth
 
     bot.start()
 
 
-```` represents the Discord event name - but lowercase and any spaces replaced with ``_``.
+``xxx`` represents the Discord event name - but with lowercase characters and any spaces replaced with ``_``.
 
 For example:
 
@@ -74,7 +74,7 @@ as long as you don't absolutely need it.
 
 
 Event: ``on_start``
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 This event fires only when the bot is started.
 
 This function takes no arguments.
@@ -83,7 +83,7 @@ This function takes no arguments.
     Unlike ``on_ready``, this event will never be dispatched more than once.
 
 Event: ``on_interaction``
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 This event fires on any interaction (commands, components, autocomplete and modals).
 
 The function needs one argument. It will have the type ``CommandContext`` or ``ComponentContext``.
@@ -93,7 +93,7 @@ recommend using this event unless you have experience with it.
 
 
 Event: ``on_command``
-^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 This event fires on any Application Command (slash command + context menu command) used.
 
 The function takes in one argument of the type ``CommandContext``.
@@ -113,7 +113,7 @@ The function takes in two arguments, one of the type ``CommandContext``, and the
 
 
 Event: ``on_component``
-^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 This event fires on any Component used (for now, those are Buttons and Select Menus).
 
 The function takes in one argument of the type ``ComponentContext``.
@@ -141,27 +141,24 @@ The function takes in one argument of the type ``CommandContext``.
 You will have to get all values yourself and check what modal was used when using this event.
 
 
-Additionally, if you struggle with getting the values, you can check
-:ref:`how it is handled internally `.
-
 
 After this, let us look at events from the Discord API.
 
 Discord API Events
 ******************
 
 Events in this section do not match the name needed to put into the function. Please check
-:ref:`above ` for how to get the correct name.
+:ref:`above<events:How to listen for events>` for how to get the correct name.
 
 
-There are a lot of events dispatched by the Discord API. All of those can be found `here`_.
+There are a lot of events dispatched by the Discord API. All of those can be found `here <https://discord.com/developers/docs/topics/gateway-events#receive-events>`_.
 
 The events ``HELLO``, ``RESUMED``, ``RECONNECT``, ``INVALID SESSION`` and ``TYPING START`` are not dispatched by the library.
 
 ``TYPING START`` will be included in the raw socket create event. You can
 also listen for it if you choose to subclass the WebSocketClient
 
-The event ``VOICE STATE UPDATE`` can be only received with the voice :ref:`Extension `.
+The event ``VOICE STATE UPDATE`` can be only received with the :ref:`voice extension<faq:Extension libraries>`.
 
 
 Let's now have a look at a few events:
@@ -197,6 +194,3 @@ The function takes in one argument of the type ``GuildMember``.
 
 The argument has the same methods as a normal ``Member`` object, except the methods *do not take in a guild id*.
 Please keep that in mind when using this event.
-
-
-.. _here: https://Discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -206,7 +206,7 @@ You can get those object via the ``get_channel()`` and ``get_guild()`` methods o
 
 
 "``ctx.send got an unexpected keyword argument: files``"! Why?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 It is not supported due to an decision of the core developer team.
 There are two ways to do it:
 
@@ -215,7 +215,7 @@ There are two ways to do it:
 
 
 "``ctx.send got an unexpected keyword argument: embed``"! Why?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This is quite simple: The argument ``embed`` got deprecated by Discord. The new naming is ``embeds``.
 
 
@@ -244,7 +244,7 @@ You can additionally get the exact reason for why the exception occurred with ``
 
 
 My message content is always empty! How can I fix this?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This happens because you did not enable the intent for message content. Enable it on the developer portal and
 add it into the ``Client`` definition as the following:
 ``bot = interactions.Client(..., intents=interactions.Intents.DEFAULT | interactions.Intents.GUILD_MESSAGE_CONTENT)``

diff --git a/docs/models.rst b/docs/models.rst
@@ -1,7 +1,7 @@
 .. currentmodule:: interactions
 
-Interaction Models
-==================
+Commands & Components
+=====================
 
 .. toctree::
     :maxdepth: 2

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -4,7 +4,7 @@ Quickstart
 Installing
 **********
 
-**discord-interactions** is a :ref:`Python library <index:interactions.py>` for the Discord Application Programming Interface. (API)
+**interactions.py** is a :ref:`Python library <index:interactions.py>` for the Discord Application Programming Interface. (API)
 A library in Python has to be installed through the `pip` file. Run this in your terminal/command line
 in order to install our library:
 
@@ -99,7 +99,7 @@ Let's take a look now at what is happening here:
 
 
 Now, let's create our first slash command:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: python
 
@@ -561,7 +561,7 @@ Responding to a Modal interaction
 You can respond to a modal the same way as you would respond to a normal ``chat-input`` command, except your function has an extra argument for the text what was put into the modal.
 
 Adding v2 Permissions
-^^^^^^^^^^^^^^^^^^^^^
+*********************
 
 v2 permissions consist of the ``default_member_permissions`` and ``dm_permission`` keyword arguments.
 Similar to adding privileged intents, you add permissions (like admin-only, ``BAN_MEMBERS``-only, etc.) as follows:
@@ -625,7 +625,7 @@ Likewise, setting ``dm_permission`` to ``True`` makes it usable in DMs. Just to
 global commands. Guild commands with this argument will have no effect.
 
 Utilities
-^^^^^^^^^
+*********
 
 You can use the following utilities to help you with your commands:
 

diff --git a/docs/utils.get.rst b/docs/utils.get.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: interactions
+
+The ``get`` utility method
+==========================
+
+.. automodule:: interactions.utils.get
+    :members: