Merge pull request #1095 from interactions-py/unstable

chore: merge unstable into stable

Author: FayeDel

docs/api.models.emoji.rst

@@ -0,0 +1,7 @@
+.. currentmodule:: interactions
+
+Emoji Models
+================
+
+.. automodule:: interactions.api.models.emoji
+    :members:

docs/api.models.rst

@@ -8,6 +8,7 @@ Model Objects
 
     api.models.audit_log.rst
     api.models.channel.rst
+    api.models.emoji.rst
     api.models.guild.rst
     api.models.gw.rst
     api.models.flags.rst

docs/api.rst

@@ -20,7 +20,7 @@ Interactions
 
     ext.rst
     context.rst
-    get.rst
+    utils.rst
 
 .. toctree::
     :maxdepth: 2

docs/conf.py

@@ -37,6 +37,7 @@
 
 # descriptions of the relevant function/method.
 autodoc_typehints = "description"
+autodoc_typehints_description_target = "documented_params"
 
 extensions = [
     "sphinx.ext.autodoc",

docs/events.rst

@@ -66,9 +66,10 @@ Event: ``raw_socket_create``
 This event fires on any event sent by Discord, including ``Typing Start``  and ``Voice State Update``.
 ``Hello``, ``Resumed``, ``Reconnect`` and ``Invalid Session`` still will not be dispatched.
 
-The function handling the event should take in one argument, the type of this argument is a ``dict``.
+A function handling an event should take two arguments,
+the first argument is the name of the event, the second is the data of that event with type ``dict``.
 
-The value of the argument will be the *raw* data sent from Discord, so it is not recommended to use that event
+The value of the second argument will be the *raw* data sent from Discord, so it is not recommended to use that event
 as long as you don't absolutely need it.
 
 

docs/get.rst

@@ -8,7 +8,7 @@ Ever since December 2019, this open-source project has become the culmination of
 - Looking for a compatible library that implements all interactions?
 - Itching to get your hands on slash commands, but in a simple manner?
 
-Look no more! The goal of this library is to make all three of these questions go from possibilites to trivial matters.
+Look no more! The goal of this library is to make all three of these questions go from possibilities to trivial matters.
 
 What can we do?
 ***************
@@ -63,10 +63,10 @@ This open-source project utilizes the following workflows for development:
 #. **pre-commit** ``2.20.0``: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.
 
    #. **black** ``22.6.0``
-   #. **flake8** ``4.0.1``
+   #. **flake8** ``5.0.4``
    #. **isort** ``5.10.1``
 
-#. **Sphinx** ``4.4.0``: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.
+#. **Sphinx** ``5.1.1``: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.
 #. **Conventional Commits** ``1.0.0``: every commit that we make to our branches use the official specification of CC 1.0.0 to make git graphs easier when improving and refining communication between code reviews, Pull Requests and commits.
 
 When can I start?

docs/index.rst

@@ -9,14 +9,14 @@ msgid ""
 msgstr ""
 "Project-Id-Version: interactions.py 4.3\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-07-17 16:00-0400\n"
+"POT-Creation-Date: 2022-09-26 12:28-0400\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.9.1\n"
+"Generated-By: Babel 2.10.3\n"
 
 #: ../../api.dispatch.rst:4
 msgid "Dispatching"
@@ -38,12 +38,6 @@ msgstr ""
 msgid "A list of events being dispatched."
 msgstr ""
 
-#: interactions.api.dispatch.Listener
-#: interactions.api.dispatch.Listener.dispatch
-#: interactions.api.dispatch.Listener.register of
-msgid "Return type"
-msgstr ""
-
 #: interactions.api.dispatch.Listener.dispatch:1 of
 msgid "Dispatches an event given out by the gateway."
 msgstr ""
@@ -83,3 +77,6 @@ msgstr ""
 #: interactions.api.dispatch.Listener.register:9 of
 msgid "The name to associate the coroutine with. Defaults to None."
 msgstr ""
+
+#~ msgid "Return type"
+#~ msgstr ""