interactions-py · FayeDel · Jul 24, 2022 · Jul 15, 2022 · Jul 15, 2022 · Jul 15, 2022
diff --git a/.github/ISSUE_TEMPLATE/report-bug.yml b/.github/ISSUE_TEMPLATE/report-bug.yml
@@ -7,9 +7,9 @@ assignees:
   - EdVraz
   - Astrea49
   - Toricane
+  - Catalyst4222
 body:
   - type: markdown
-    id: thanks
     attributes:
       value: |
         Thank you for taking the time to fill out this bug report!

diff --git a/.github/ISSUE_TEMPLATE/request-feature.yml b/.github/ISSUE_TEMPLATE/request-feature.yml
@@ -7,9 +7,9 @@ assignees:
   - EdVraz
   - Astrea49
   - Toricane
+  - Catalyst4222
 body:
   - type: markdown
-    id: thanks
     attributes:
       value: |
         Thank you for taking the time to fill out this feature request!

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,8 +6,8 @@ This pull request is about (X), which does (Y).
 
 - [ ] I've ran `pre-commit` to format and lint the change(s) made.
 - [ ] I've checked to make sure the change(s) work on `3.8.6` and higher.
-- [ ] This fixes/solves an [Issue](https://github.com/goverfl0w/discord-interactions/issues).
-  - (If existent):
+- [ ] This fixes/solves an [Issue](https://github.com/goverfl0w/discord-interactions/issues) (If existent):.
+  - resolves #
 - I've made this pull request for/as: (check all that apply)
   - [ ] Documentation
   - [ ] Breaking change

diff --git a/README.rst b/README.rst
@@ -41,7 +41,7 @@ Some more unique features that are exclusive to our interactions include:
 - **Event-triggered callbacks**: whether a component, application command or interaction response, you'll never need to worry about bridging responses.
 - **Dual-way decorator logic**: a decorator can act as both a constructor for an interaction, as well as a callback.
 - **API-strict naming**: no more confusion with the naming approach of many libraries; we follow the naming style of interactions from the officially curated Discord Developers documentation.
-- **Extensive framework structure**: (**pending in** ``4.1.0``) build your own tools and technologies for our library to develop and integrate community creations.
+- **Extensive framework structure**: build your own tools and technologies for our library to develop and integrate community creations.
 
 What do we not offer?
 *********************
@@ -65,11 +65,11 @@ Please read up on our `contribution requirements`_ for the project. This open-so
 
 This open-source project utilizes the following workflows for development:
 
-#. **pre-commit** ``2.16.0``: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.
+#. **pre-commit** ``2.20.0``: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.
 
-   #. **black** ``21.11b1``
-   #. **flake8** ``3.9.2``
-   #. **isort** ``5.9.3``
+   #. **black** ``22.6.0``
+   #. **flake8** ``4.0.1``
+   #. **isort** ``5.10.1``
 
 #. **Sphinx** ``4.1.2``: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.
 #. **colorama** ``0.4.4``: our internal logger uses a customized coloring formatter to make looking for specific conditions easier when running tests.

diff --git a/docs/api.cache.rst b/docs/api.cache.rst
@@ -5,4 +5,3 @@ Client Cache
 
 .. automodule:: interactions.api.cache
     :members:
-    :noindex:
diff --git a/docs/api.dispatch.rst b/docs/api.dispatch.rst
@@ -5,4 +5,3 @@ Dispatching
 
 .. automodule:: interactions.api.dispatch
     :members:
-    :noindex:
diff --git a/docs/api.enums.rst b/docs/api.enums.rst
@@ -5,4 +5,3 @@ Enumerable Objects
 
 .. automodule:: interactions.api.enums
     :members:
-    :noindex:
diff --git a/docs/api.error.rst b/docs/api.error.rst
@@ -5,4 +5,3 @@ Error Exceptions
 
 .. automodule:: interactions.api.error
     :members:
-    :noindex:
diff --git a/docs/api.gateway.rst b/docs/api.gateway.rst
@@ -5,12 +5,9 @@ Gateway
 
 .. automodule:: interactions.api.gateway
     :members:
-    :noindex:
 
 .. automodule:: interactions.api.gateway.client
     :members:
-    :noindex:
 
 .. automodule:: interactions.api.gateway.heartbeat
     :members:
-    :noindex:
diff --git a/docs/api.http.rst b/docs/api.http.rst
@@ -5,64 +5,48 @@ HTTP
 
 .. 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:
-    :noindex:
 
 .. autoclass:: interactions.api.http.channel.ChannelRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.emoji.EmojiRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.guild.GuildRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.interaction.InteractionRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.member.MemberRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.message.MessageRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.reaction.ReactionRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.scheduledEvent.ScheduledEventRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.sticker.StickerRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.thread.ThreadRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.user.UserRequest
     :members:
-    :noindex:
 
 .. autoclass:: interactions.api.http.webhook.WebhookRequest
     :members:
-    :noindex:
diff --git a/docs/api.models.audit_log.rst b/docs/api.models.audit_log.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: interactions
+
+Audit-Log Models
+================
+
+.. automodule:: interactions.api.models.audit_log
+    :members:
diff --git a/docs/api.models.channel.rst b/docs/api.models.channel.rst
@@ -5,4 +5,3 @@ Channel Models
 
 .. automodule:: interactions.api.models.channel
     :members:
-    :noindex:
diff --git a/docs/api.models.flags.rst b/docs/api.models.flags.rst
@@ -5,4 +5,3 @@ Flag Bitshift Models
 
 .. automodule:: interactions.api.models.flags
     :members:
-    :noindex:
diff --git a/docs/api.models.guild.rst b/docs/api.models.guild.rst
@@ -5,4 +5,3 @@ Guild Models
 
 .. automodule:: interactions.api.models.guild
     :members:
-    :noindex:
diff --git a/docs/api.models.gw.rst b/docs/api.models.gw.rst
@@ -5,4 +5,3 @@ Gateway-specific Event Models
 
 .. automodule:: interactions.api.models.gw
     :members:
-    :noindex:
diff --git a/docs/api.models.member.rst b/docs/api.models.member.rst
@@ -5,4 +5,3 @@ Member Models
 
 .. automodule:: interactions.api.models.member
     :members:
-    :noindex:
diff --git a/docs/api.models.message.rst b/docs/api.models.message.rst
@@ -5,4 +5,3 @@ Message Models
 
 .. automodule:: interactions.api.models.message
     :members:
-    :noindex:
diff --git a/docs/api.models.misc.rst b/docs/api.models.misc.rst
@@ -5,4 +5,3 @@ Miscellanous Models
 
 .. automodule:: interactions.api.models.misc
     :members:
-    :noindex:
diff --git a/docs/api.models.presence.rst b/docs/api.models.presence.rst
@@ -5,4 +5,3 @@ Presence Models
 
 .. automodule:: interactions.api.models.presence
     :members:
-    :noindex:
diff --git a/docs/api.models.role.rst b/docs/api.models.role.rst
@@ -5,4 +5,3 @@ Role Models
 
 .. automodule:: interactions.api.models.role
     :members:
-    :noindex:
diff --git a/docs/api.models.rst b/docs/api.models.rst
@@ -6,6 +6,7 @@ Model Objects
 .. toctree::
     :maxdepth: 2
 
+    api.models.audit_log.rst
     api.models.channel.rst
     api.models.guild.rst
     api.models.gw.rst

diff --git a/docs/api.models.team.rst b/docs/api.models.team.rst
@@ -5,4 +5,3 @@ Team Models
 
 .. automodule:: interactions.api.models.team
     :members:
-    :noindex:
diff --git a/docs/api.models.user.rst b/docs/api.models.user.rst
@@ -5,4 +5,3 @@ User Models
 
 .. automodule:: interactions.api.models.user
     :members:
-    :noindex:
diff --git a/docs/api.models.webhook.rst b/docs/api.models.webhook.rst
@@ -5,4 +5,3 @@ Webhook Models
 
 .. automodule:: interactions.api.models.webhook
     :members:
-    :noindex:
diff --git a/docs/client.rst b/docs/client.rst
@@ -5,4 +5,3 @@ Bot Client
 
 .. automodule:: interactions.client.bot
     :members:
-    :noindex:
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,13 +33,18 @@
 autosectionlabel_prefix_document = True
 hoverxref_auto_ref = True
 hoverxref_sphinxtabs = True
+
+
+# descriptions of the relevant function/method.
+autodoc_typehints = "description"
+
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.autosectionlabel",
     "hoverxref.extension",
-    "karma_sphinx_theme",
-    "sphinx_search.extension",
+    "sphinx_copybutton",
+    "enum_tools.autoenum",
 ]
 
 # Stackoverflow said that this is gonna cure my LaTeX errors for ref handling.
@@ -80,7 +85,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "karma_sphinx_theme"
+html_theme = "furo"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/context.rst b/docs/context.rst
@@ -6,4 +6,3 @@ Event Context
 .. automodule:: interactions.client.context
     :members:
     :inherited-members:
-    :noindex:
diff --git a/docs/enums.rst b/docs/enums.rst
@@ -5,4 +5,3 @@ Enumerable Objects
 
 .. automodule:: interactions.client.enums
     :members:
-    :noindex:
diff --git a/docs/events.rst b/docs/events.rst
@@ -51,8 +51,10 @@ All events mentioned in this section have the exact naming as they must be put i
 There are several different internal events:
 
     - ``raw_socket_create``
+    - ``on_start``
     - ``on_interaction``
     - ``on_command``
+    - ``on_command_error``
     - ``on_component``
     - ``on_autocomplete``
     - ``on_modal``
@@ -70,6 +72,15 @@ The value of the argument will be the *raw* data sent from Discord, so it is not
 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.
+
+.. attention::
+    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).
@@ -90,6 +101,16 @@ Using this event, you will have to manually check everything, from name to wheth
 options or anything else - everything will be in the raw context and you will have to search for it
 
 
+Event: ``on_command_error``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+This event fires when the following conditions are met:
+
+1. There is an error in the command (or subcommand within the command)
+2. There is no error callback assigned to that command
+
+The function takes in two arguments, one of the type ``CommandContext``, and the other contains the error.
+
+
 Event: ``on_component``
 ^^^^^^^^^^^^^^^^^^^^^^
 This event fires on any Component used (for now, those are Buttons and Select Menus).

diff --git a/docs/ext.base.rst b/docs/ext.base.rst
@@ -5,4 +5,3 @@ Core Model
 
 .. automodule:: interactions.ext.base
     :members:
-    :noindex:
diff --git a/docs/ext.converter.rst b/docs/ext.converter.rst
@@ -5,4 +5,3 @@ Converter Model
 
 .. automodule:: interactions.ext.converter
     :members:
-    :noindex:
diff --git a/docs/ext.error.rst b/docs/ext.error.rst
@@ -5,4 +5,3 @@ Error Exceptions
 
 .. automodule:: interactions.ext.error
     :members:
-    :noindex:
diff --git a/docs/ext.version.rst b/docs/ext.version.rst
@@ -5,4 +5,3 @@ Versioning Models
 
 .. automodule:: interactions.ext.version
     :members:
-    :noindex:
diff --git a/docs/get.rst b/docs/get.rst
@@ -5,4 +5,3 @@ The ``get`` utility method
 
 .. automodule:: interactions.client.get
     :members:
-    :noindex:
diff --git a/docs/index.rst b/docs/index.rst
@@ -60,14 +60,13 @@ Please read up on our `contribution requirements`_ for the project. This open-so
 
 This open-source project utilizes the following workflows for development:
 
-#. **pre-commit** ``2.16.0``: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.
+#. **pre-commit** ``2.20.0``: the architecture uses this before every commit to format and check for severity/QOL-breaking changes.
 
-   #. **black** ``21.11b1``
-   #. **flake8** ``3.9.2``
-   #. **isort** ``5.9.3``
+   #. **black** ``22.6.0``
+   #. **flake8** ``4.0.1``
+   #. **isort** ``5.10.1``
 
-#. **Sphinx** ``4.1.2``: all of our documentation is powered off of autogenerated documentation of the Sphinx engine.
-#. **colorama** ``0.4.4``: our internal logger uses a customized coloring formatter to make looking for specific conditions easier when running tests.
+#. **Sphinx** ``4.4.0``: 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?
@@ -87,7 +86,6 @@ Advanced Search
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
 
 .. _contribution requirements: https://github.com/interactions-py/library/blob/stable/CONTRIBUTING.rst
 .. _MIT License: https://github.com/interactions-py/library/blob/stable/LICENSE
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Client Cache

		.. automodule:: interactions.api.cache
		:members:
		:noindex:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Dispatching

		.. automodule:: interactions.api.dispatch
		:members:
		:noindex:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Enumerable Objects

		.. automodule:: interactions.api.enums
		:members:
		:noindex:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Error Exceptions

		.. automodule:: interactions.api.error
		:members:
		:noindex:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Channel Models

		.. automodule:: interactions.api.models.channel
		:members:
		:noindex:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Flag Bitshift Models

		.. automodule:: interactions.api.models.flags
		:members:
		:noindex:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Guild Models

		.. automodule:: interactions.api.models.guild
		:members:
		:noindex:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Gateway-specific Event Models

		.. automodule:: interactions.api.models.gw
		:members:
		:noindex:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Member Models

		.. automodule:: interactions.api.models.member
		:members:
		:noindex:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,3 @@ Message Models

		.. automodule:: interactions.api.models.message
		:members:
		:noindex: