docs: 📝 Fixes (#3030)

* 📝 Fix formatting for gateway links in docstrings

* 📝 Fix documentation for default value type in mentionable select

* 🐛 Fix import path for Interaction in label.py

* 📝 Exclude 'cog' member from SlashCommand documentation

* 📝 Fix documentation of `check_any`

* 📝 Fix section heading underline lenght in docstring sections

Author: Paillat-dev

discord/automod.py

@@ -207,7 +207,7 @@ class AutoModTriggerMetadata:
     +-----------------------------+--------------------------------------------------------------------------------+
 
     Each attribute has limits that may change based on the trigger type.
-    See `here <https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata-field-limits>`_
+    See `here <https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata-field-limits>`__
     for information on attribute limits.
 
     .. versionadded:: 2.0

discord/ext/commands/core.py

@@ -1799,7 +1799,7 @@ async def extended_check(ctx):
         The ``predicate`` attribute was added.
 
     Examples
-    ---------
+    --------
 
     Creating a basic check to see if the command invoker is you.
 
@@ -1828,7 +1828,7 @@ async def only_me(ctx):
             await ctx.send('Only you!')
 
     Parameters
-    -----------
+    ----------
     predicate: Callable[[:class:`Context`], :class:`bool`]
         The predicate to check if the command should be invoked.
     """
@@ -1870,20 +1870,8 @@ def check_any(*checks: Check) -> Callable[[T], T]:
 
     .. versionadded:: 1.3
 
-    Parameters
-    ------------
-    \*checks: Callable[[:class:`Context`], :class:`bool`]
-        An argument list of checks that have been decorated with
-        the :func:`check` decorator.
-
-    Raises
-    ------
-    TypeError
-        A check passed has not been decorated with the :func:`check`
-        decorator.
-
     Examples
-    ---------
+    --------
 
     Creating a basic check to see if it's the bot owner or
     the server owner:
@@ -1900,6 +1888,18 @@ def predicate(ctx):
         async def only_for_owners(ctx):
             await ctx.send('Hello mister owner!')
 
+    Parameters
+    ----------
+    \*checks: Callable[[:class:`Context`], :class:`bool`]
+        An argument list of checks that have been decorated with
+        the :func:`check` decorator.
+
+    Raises
+    ------
+    TypeError
+        A check passed has not been decorated with the :func:`check`
+        decorator.
+
     """
 
     unwrapped = []
@@ -1989,12 +1989,12 @@ def has_any_role(*items: int | str) -> Callable[[T], T]:
         instead of generic :exc:`.CheckFailure`
 
     Parameters
-    -----------
+    ----------
     items: List[Union[:class:`str`, :class:`int`]]
         An argument list of names or IDs to check that the member has roles wise.
 
     Example
-    --------
+    -------
 
     .. code-block:: python3
 
@@ -2104,12 +2104,12 @@ def has_permissions(**perms: bool) -> Callable[[T], T]:
     If the command is executed within a DM, it returns ``True``.
 
     Parameters
-    ------------
+    ----------
     \*\*perms: Dict[:class:`str`, :class:`bool`]
         An argument list of permissions to check for.
 
     Example
-    ---------
+    -------
 
     .. code-block:: python3
 

discord/raw_models.py

@@ -113,7 +113,7 @@ class RawMessageDeleteEvent(_RawReprMixin):
     cached_message: Optional[:class:`Message`]
         The cached message, if found in the internal message cache.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-delete>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-delete>`__.
 
         .. versionadded:: 2.5
     """
@@ -145,7 +145,7 @@ class RawBulkMessageDeleteEvent(_RawReprMixin):
     cached_messages: List[:class:`Message`]
         The cached messages, if found in the internal message cache.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk>`__.
 
         .. versionadded:: 2.5
     """
@@ -181,7 +181,7 @@ class RawMessageUpdateEvent(_RawReprMixin):
         .. versionadded:: 1.7
 
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway#message-update>`_
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway#message-update>`__
     cached_message: Optional[:class:`Message`]
         The cached message, if found in the internal message cache. Represents the message before
         it is modified by the data in :attr:`RawMessageUpdateEvent.data`.
@@ -244,7 +244,7 @@ class RawReactionActionEvent(_RawReprMixin):
     type: :class:`ReactionType`
         The type of reaction added.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-reaction-add>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-reaction-add>`__.
 
         .. versionadded:: 2.5
     """
@@ -297,7 +297,7 @@ class RawReactionClearEvent(_RawReprMixin):
     guild_id: Optional[:class:`int`]
         The guild ID where the reactions got cleared.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all>`__.
 
         .. versionadded:: 2.5
     """
@@ -339,7 +339,7 @@ class RawReactionClearEmojiEvent(_RawReprMixin):
     type: :class:`ReactionType`
         The type of reaction removed.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji>`__.
 
         .. versionadded:: 2.5
     """
@@ -386,7 +386,7 @@ class RawIntegrationDeleteEvent(_RawReprMixin):
     guild_id: :class:`int`
         The guild ID where the integration got deleted.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#integration-delete>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#integration-delete>`__.
 
         .. versionadded:: 2.5
     """
@@ -420,7 +420,7 @@ class RawThreadUpdateEvent(_RawReprMixin):
     parent_id: :class:`int`
         The ID of the channel the thread belongs to.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#thread-update>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#thread-update>`__.
     thread: :class:`discord.Thread` | None
         The thread, if it could be found in the internal cache.
     """
@@ -455,7 +455,7 @@ class RawThreadDeleteEvent(_RawReprMixin):
     thread: Optional[:class:`discord.Thread`]
         The thread that was deleted. This may be ``None`` if deleted thread is not found in internal cache.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#thread-delete>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#thread-delete>`__.
 
         .. versionadded:: 2.5
     """
@@ -485,7 +485,7 @@ class RawVoiceChannelStatusUpdateEvent(_RawReprMixin):
     status: Optional[:class:`str`]
         The new new voice channel status.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#voice-channel-status-update>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#voice-channel-status-update>`__.
     """
 
     __slots__ = ("id", "guild_id", "status", "data")
@@ -519,7 +519,7 @@ class RawTypingEvent(_RawReprMixin):
     member: Optional[:class:`Member`]
         The member who started typing. Only available if the member started typing in a guild.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#typing-start>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#typing-start>`__.
 
         .. versionadded:: 2.5
     """
@@ -553,7 +553,7 @@ class RawMemberRemoveEvent(_RawReprMixin):
     guild_id: :class:`int`
         The ID of the guild the user left.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#guild-member-remove>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#guild-member-remove>`__.
 
         .. versionadded:: 2.5
     """
@@ -584,7 +584,7 @@ class RawScheduledEventSubscription(_RawReprMixin):
         Can be either ``USER_ADD`` or ``USER_REMOVE`` depending on
         the event called.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add>`__.
 
         .. versionadded:: 2.5
     """
@@ -644,7 +644,7 @@ class AutoModActionExecutionEvent:
     matched_content: :class:`str`
         The substring in the content that was matched.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution>`__.
 
         .. versionadded:: 2.5
     """
@@ -739,7 +739,7 @@ class RawThreadMembersUpdateEvent(_RawReprMixin):
     member_count: :class:`int`
         The approximate number of members in the thread. Maximum of 50.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#thread-members-update>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#thread-members-update>`__.
 
         .. versionadded:: 2.5
     """
@@ -780,7 +780,7 @@ class RawAuditLogEntryEvent(_RawReprMixin):
         contains extra information. See :class:`AuditLogAction` for
         which actions have this field filled out.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create>`_.
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create>`__.
     """
 
     __slots__ = (
@@ -831,7 +831,7 @@ class RawMessagePollVoteEvent(_RawReprMixin):
     added: :class:`bool`
         Whether this vote was added or removed.
     data: :class:`dict`
-        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway#message-poll-vote-add>`
+        The raw data sent by the `gateway <https://discord.com/developers/docs/topics/gateway#message-poll-vote-add>`__
     """
 
     __slots__ = (

discord/ui/label.py

@@ -43,7 +43,7 @@
     from typing_extensions import Self
 
     from ..emoji import AppEmoji, GuildEmoji
-    from ..interaction import Interaction
+    from ..interactions import Interaction
     from ..partial_emoji import PartialEmoji, _EmojiTag
     from ..types.components import LabelComponent as LabelComponentPayload
     from .modal import DesignerModal

discord/ui/select.py

@@ -464,8 +464,8 @@ def add_default_value(
         id: :class:`int`
             The ID of the entity to add as a default.
         type: :class:`discord.SelectDefaultValueType`
-            The default value type of the ID. This is only required if :attr:`.type` is of
-            type :attr:`discord.ComponentType.mentionable_select`.
+            The default value type of the ID. This is only required if the select ``type`` is
+            :attr:`discord.ComponentType.mentionable_select`.
 
         Raises
         ------

docs/api/application_commands.rst

@@ -48,6 +48,7 @@ Objects
 .. attributetable:: SlashCommand
 .. autoclass:: SlashCommand
     :members:
+    :exclude-members: cog
 
 .. attributetable:: SlashCommandGroup
 .. autoclass:: SlashCommandGroup