style: enable D301 (#1469)

Author: onerandomusername

disnake/abc.py

@@ -503,7 +503,7 @@ def _fill_overwrites(self, data: GuildChannelPayload) -> None:
 
     @property
     def changed_roles(self) -> list[Role]:
-        """:class:`list`\\[:class:`.Role`]: Returns a list of roles that have been overridden from
+        r""":class:`list`\[:class:`.Role`]: Returns a list of roles that have been overridden from
         their default values in the :attr:`.Guild.roles` attribute.
         """
         ret: list[Role] = []
@@ -560,15 +560,15 @@ def overwrites_for(self, obj: Role | User) -> PermissionOverwrite:
 
     @property
     def overwrites(self) -> dict[Role | Member, PermissionOverwrite]:
-        """Returns all of the channel's overwrites.
+        r"""Returns all of the channel's overwrites.
 
         This is returned as a dictionary where the key contains the target which
         can be either a :class:`~disnake.Role` or a :class:`~disnake.Member` and the value is the
         overwrite as a :class:`~disnake.PermissionOverwrite`.
 
         Returns
         -------
-        :class:`dict`\\[:class:`~disnake.Role` | :class:`~disnake.Member`, :class:`~disnake.PermissionOverwrite`]
+        :class:`dict`\[:class:`~disnake.Role` | :class:`~disnake.Member`, :class:`~disnake.PermissionOverwrite`]
             The channel's permission overwrites.
         """
         ret = {}
@@ -1385,7 +1385,7 @@ async def create_invite(
         return invite
 
     async def invites(self) -> list[Invite]:
-        """|coro|
+        r"""|coro|
 
         Returns a list of all active instant invites from this channel.
 
@@ -1400,7 +1400,7 @@ async def invites(self) -> list[Invite]:
 
         Returns
         -------
-        :class:`list`\\[:class:`.Invite`]
+        :class:`list`\[:class:`.Invite`]
             The list of invites that are currently active.
         """
         state = self._state
@@ -1537,7 +1537,7 @@ async def send(
         components: MessageComponents | None = None,
         poll: Poll | None = None,
     ):
-        """|coro|
+        r"""|coro|
 
         Sends a message to the destination with the content given.
 
@@ -1568,18 +1568,18 @@ async def send(
         embed: :class:`.Embed`
             The rich embed for the content to send. This cannot be mixed with the
             ``embeds`` parameter.
-        embeds: :class:`list`\\[:class:`.Embed`]
+        embeds: :class:`list`\[:class:`.Embed`]
             A list of embeds to send with the content. Must be a maximum of 10.
             This cannot be mixed with the ``embed`` parameter.
 
             .. versionadded:: 2.0
 
         file: :class:`~disnake.File`
             The file to upload. This cannot be mixed with the ``files`` parameter.
-        files: :class:`list`\\[:class:`~disnake.File`]
+        files: :class:`list`\[:class:`~disnake.File`]
             A list of files to upload. Must be a maximum of 10.
             This cannot be mixed with the ``file`` parameter.
-        stickers: :class:`~collections.abc.Sequence`\\[:class:`.GuildSticker` | :class:`.StandardSticker` | :class:`.StickerItem`]
+        stickers: :class:`~collections.abc.Sequence`\[:class:`.GuildSticker` | :class:`.StandardSticker` | :class:`.StickerItem`]
             A list of stickers to upload. Must be a maximum of 3.
 
             .. versionadded:: 2.0
@@ -1880,7 +1880,7 @@ async def fetch_message(self, id: int, /) -> Message:
     def pins(
         self, *, limit: int | None = 50, before: SnowflakeTime | None = None
     ) -> ChannelPinsIterator:
-        """Returns an :class:`.AsyncIterator` that enables receiving the destination's pinned messages.
+        r"""Returns an :class:`.AsyncIterator` that enables receiving the destination's pinned messages.
 
         You must have the :attr:`.Permissions.read_message_history` and :attr:`.Permissions.view_channel` permissions to use this.
 
@@ -1892,7 +1892,7 @@ def pins(
 
         .. versionchanged:: 2.11
             Now returns an :class:`.AsyncIterator` to support changes in Discord's API.
-            ``await``\\ing the result of this method remains supported, but only returns the
+            ``await``\ing the result of this method remains supported, but only returns the
             last 50 pins and is deprecated in favor of ``async for msg in channel.pins()``.
 
         Examples
@@ -2041,7 +2041,7 @@ async def connect(
         reconnect: bool = True,
         cls: Callable[[Client, Connectable], VoiceProtocolT] = VoiceClient,
     ) -> VoiceProtocolT:
-        """|coro|
+        r"""|coro|
 
         Connects to voice and creates a :class:`VoiceClient` to establish
         your connection to the voice server.
@@ -2056,7 +2056,7 @@ async def connect(
             Whether the bot should automatically attempt
             a reconnect if a part of the handshake fails
             or the gateway goes down.
-        cls: :class:`type`\\[:class:`VoiceProtocol`]
+        cls: :class:`type`\[:class:`VoiceProtocol`]
             A type that subclasses :class:`VoiceProtocol` to connect with.
             Defaults to :class:`VoiceClient`.
 

disnake/activity.py

@@ -234,7 +234,7 @@ class BaseActivity(_BaseActivity):
 
 
 class Activity(BaseActivity):
-    """Represents an activity in Discord.
+    r"""Represents an activity in Discord.
 
     This could be an activity such as streaming, playing, listening
     or watching.
@@ -283,7 +283,7 @@ class Activity(BaseActivity):
 
         - ``id``: A string representing the party ID.
         - ``size``: A list of two integers denoting (current_size, maximum_size).
-    buttons: :class:`list`\\[:class:`str`]
+    buttons: :class:`list`\[:class:`str`]
         A list of strings representing the labels of custom buttons shown in a rich presence.
 
         .. versionadded:: 2.0
@@ -746,7 +746,7 @@ def title(self) -> str:
 
     @property
     def artists(self) -> list[str]:
-        """:class:`list`\\[:class:`str`]: The artists of the song being played."""
+        r""":class:`list`\[:class:`str`]: The artists of the song being played."""
         return self._state.split("; ")
 
     @property

disnake/app_commands.py

@@ -164,7 +164,7 @@ def localize(self, store: LocalizationProtocol) -> None:
 
 
 class Option:
-    """Represents a slash command option.
+    r"""Represents a slash command option.
 
     Parameters
     ----------
@@ -184,12 +184,12 @@ class Option:
         The option type, e.g. :class:`OptionType.user`.
     required: :class:`bool`
         Whether this option is required.
-    choices: :class:`~collections.abc.Sequence`\\[:class:`OptionChoice`] | :class:`~collections.abc.Sequence`\\[:class:`str` | :class:`int` | :class:`float`] | :class:`~collections.abc.Mapping`\\[:class:`str`, :class:`str` | :class:`int` | :class:`float`]
+    choices: :class:`~collections.abc.Sequence`\[:class:`OptionChoice`] | :class:`~collections.abc.Sequence`\[:class:`str` | :class:`int` | :class:`float`] | :class:`~collections.abc.Mapping`\[:class:`str`, :class:`str` | :class:`int` | :class:`float`]
         The pre-defined choices for this option.
-    options: :class:`list`\\[:class:`Option`]
+    options: :class:`list`\[:class:`Option`]
         The list of sub options. Normally you don't have to specify it directly,
         instead consider using ``@main_cmd.sub_command`` or ``@main_cmd.sub_command_group`` decorators.
-    channel_types: :class:`list`\\[:class:`ChannelType`]
+    channel_types: :class:`list`\[:class:`ChannelType`]
         The list of channel types that your option supports, if the type is :class:`OptionType.channel`.
         By default, it supports all channel types.
     autocomplete: :class:`bool`
@@ -218,12 +218,12 @@ class Option:
         The option type, e.g. :class:`OptionType.user`.
     required: :class:`bool`
         Whether this option is required.
-    choices: :class:`list`\\[:class:`OptionChoice`]
+    choices: :class:`list`\[:class:`OptionChoice`]
         The list of pre-defined choices.
-    options: :class:`list`\\[:class:`Option`]
+    options: :class:`list`\[:class:`Option`]
         The list of sub options. Normally you don't have to specify it directly,
         instead consider using ``@main_cmd.sub_command`` or ``@main_cmd.sub_command_group`` decorators.
-    channel_types: :class:`list`\\[:class:`ChannelType`]
+    channel_types: :class:`list`\[:class:`ChannelType`]
         The list of channel types that your option supports, if the type is :class:`OptionType.channel`.
         By default, it supports all channel types.
     autocomplete: :class:`bool`
@@ -1013,7 +1013,7 @@ def from_dict(cls, data: ApplicationCommandPayload) -> Self:
 
 
 class SlashCommand(ApplicationCommand):
-    """The base class for building slash commands.
+    r"""The base class for building slash commands.
 
     Attributes
     ----------
@@ -1050,7 +1050,7 @@ class SlashCommand(ApplicationCommand):
 
         .. versionadded:: 2.10
 
-    options: :class:`list`\\[:class:`Option`]
+    options: :class:`list`\[:class:`Option`]
         The list of options the slash command has.
     """
 
@@ -1152,7 +1152,7 @@ def localize(self, store: LocalizationProtocol) -> None:
 
 
 class APISlashCommand(SlashCommand, _APIApplicationCommandMixin):
-    """A slash command returned by the API.
+    r"""A slash command returned by the API.
 
     .. versionadded:: 2.4
 
@@ -1192,7 +1192,7 @@ class APISlashCommand(SlashCommand, _APIApplicationCommandMixin):
 
     id: :class:`int`
         The slash command's ID.
-    options: :class:`list`\\[:class:`Option`]
+    options: :class:`list`\[:class:`Option`]
         The list of options the slash command has.
     application_id: :class:`int`
         The application ID this command belongs to.
@@ -1291,7 +1291,7 @@ def is_all_channels(self) -> bool:
 
 
 class GuildApplicationCommandPermissions:
-    """Represents application command permissions in a guild.
+    r"""Represents application command permissions in a guild.
 
     .. versionchanged:: 2.5
         Can now also represent application-wide permissions that apply to every command by default.
@@ -1304,7 +1304,7 @@ class GuildApplicationCommandPermissions:
         The application ID this command belongs to.
     guild_id: :class:`int`
         The ID of the guild where these permissions are applied.
-    permissions: :class:`list`\\[:class:`ApplicationCommandPermissions`]
+    permissions: :class:`list`\[:class:`ApplicationCommandPermissions`]
         A list of :class:`ApplicationCommandPermissions`.
     """
 

disnake/appinfo.py

@@ -36,7 +36,7 @@
 
 
 class InstallParams:
-    """Represents the installation parameters for the application, provided by Discord.
+    r"""Represents the installation parameters for the application, provided by Discord.
 
     .. versionadded:: 2.5
 
@@ -45,7 +45,7 @@ class InstallParams:
 
     Attributes
     ----------
-    scopes: :class:`list`\\[:class:`str`]
+    scopes: :class:`list`\[:class:`str`]
         The scopes requested by the application.
     permissions: :class:`Permissions`
         The permissions requested for the bot role.
@@ -163,7 +163,7 @@ def __repr__(self) -> str:
 
 
 class AppInfo:
-    """Represents the application info for the bot provided by Discord.
+    r"""Represents the application info for the bot provided by Discord.
 
     Attributes
     ----------
@@ -186,7 +186,7 @@ class AppInfo:
     bot_require_code_grant: :class:`bool`
         Whether the bot requires the completion of the full oauth2 code
         grant flow to join.
-    rpc_origins: :class:`list`\\[:class:`str`] | :data:`None`
+    rpc_origins: :class:`list`\[:class:`str`] | :data:`None`
         A list of RPC origin URLs, if RPC is enabled.
     verify_key: :class:`str`
         The hex encoded key for verification in interactions and the
@@ -227,7 +227,7 @@ class AppInfo:
 
         .. versionadded:: 2.3
 
-    tags: :class:`list`\\[:class:`str`] | :data:`None`
+    tags: :class:`list`\[:class:`str`] | :data:`None`
         The application's tags.
 
         .. versionadded:: 2.5
@@ -264,7 +264,7 @@ class AppInfo:
         The approximate number of users that have authorized the app with OAuth2.
 
         .. versionadded:: 2.11
-    redirect_uris: :class:`list`\\[:class:`str`] | :data:`None`
+    redirect_uris: :class:`list`\[:class:`str`] | :data:`None`
         The application's OAuth2 redirect URIs.
 
         .. versionadded:: 2.11
@@ -284,7 +284,7 @@ class AppInfo:
 
         .. versionadded:: 2.11
 
-    event_webhooks_types: :class:`list`\\[:class:`str`] | :data:`None`
+    event_webhooks_types: :class:`list`\[:class:`str`] | :data:`None`
         The application's event webhook types, if any.
 
         .. versionadded:: 2.11
@@ -473,7 +473,7 @@ async def edit(
         event_webhooks_status: ApplicationEventWebhookStatus = MISSING,
         event_webhooks_types: Sequence[str] = MISSING,
     ) -> AppInfo:
-        """|coro|
+        r"""|coro|
 
         Edit's the application's information.
 
@@ -531,13 +531,13 @@ async def edit(
             Update the cover_image for rich presence integrations.
         interactions_endpoint_url: :class:`str` | :data:`None`
             The application's interactions endpoint URL.
-        tags: :class:`list`\\[:class:`str`]
+        tags: :class:`list`\[:class:`str`]
             The application's tags.
         event_webhooks_url: :class:`str` | :data:`None`
             The application's event webhooks URL.
         event_webhooks_status: :class:`ApplicationEventWebhookStatus`
             The application's event webhooks status.
-        event_webhooks_types: :class:`list`\\[:class:`str`] | :data:`None`
+        event_webhooks_types: :class:`list`\[:class:`str`] | :data:`None`
             The application's event webhook types. See `webhook event types <https://discord.com/developers/docs/events/webhook-events#event-types>`_
             for a list of valid events.
 
@@ -644,7 +644,7 @@ async def edit(
 
 
 class PartialAppInfo:
-    """Represents a partial AppInfo given by :func:`~disnake.abc.GuildChannel.create_invite`.
+    r"""Represents a partial AppInfo given by :func:`~disnake.abc.GuildChannel.create_invite`.
 
     .. versionadded:: 2.0
 
@@ -656,7 +656,7 @@ class PartialAppInfo:
         The application's name.
     description: :class:`str`
         The application's description.
-    rpc_origins: :class:`list`\\[:class:`str`] | :data:`None`
+    rpc_origins: :class:`list`\[:class:`str`] | :data:`None`
         A list of RPC origin URLs, if RPC is enabled.
     verify_key: :class:`str`
         The hex encoded key for verification in interactions and the

disnake/audit_logs.py

@@ -518,7 +518,7 @@ class _AuditLogProxyKickOrMemberRoleAction:
 
 
 class AuditLogEntry(Hashable):
-    """Represents an Audit Log entry.
+    r"""Represents an Audit Log entry.
 
     You can retrieve these via :meth:`Guild.audit_logs`,
     or via the :func:`on_audit_log_entry_create` event.
@@ -545,7 +545,7 @@ class AuditLogEntry(Hashable):
     action: :class:`AuditLogAction`
         The action that was done.
     user: :class:`Member` | :class:`User` | :class:`Object` | :data:`None`
-        The user who initiated this action. Usually :class:`Member`\\, unless gone
+        The user who initiated this action. Usually :class:`Member`\, unless gone
         then it's a :class:`User`.
 
         .. versionchanged:: 2.8