feat: add codespell configuration (#1368)

Signed-off-by: arielle <[email protected]>
Co-authored-by: vi <[email protected]>

Author: onerandomusername

.github/workflows/lint-test.yml

@@ -48,7 +48,7 @@ jobs:
 
   # Used to determine which python versions to test against.
   # noxfile.py is the source of truth, which in turn draws from
-  # pyproject.toml's `project.requires-python` and `project.classifers`.
+  # pyproject.toml's `project.requires-python` and `project.classifiers`.
   python-versions:
     runs-on: ubuntu-latest
     outputs:

.pre-commit-config.yaml

@@ -19,6 +19,14 @@ repos:
       - id: pretty-format-yaml
         args: [--autofix, --indent, '2', --offset, '2', '--preserve-quotes']
 
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args: ['--write']
+        additional_dependencies:
+          - tomli
+
   - repo: local
     hooks:
       - id: no-symlinks

disnake/channel.py

@@ -3478,7 +3478,7 @@ def available_tags(self) -> List[ForumTag]:
     async def trigger_typing(self) -> None:
         """|coro|
 
-        Triggers a *typing* indicator to the desination.
+        Triggers a *typing* indicator to the destination.
 
         *Typing* indicator will go away after 10 seconds.
         """

disnake/client.py

@@ -3008,7 +3008,7 @@ async def delete_guild_command(self, guild_id: int, command_id: int) -> None:
         Parameters
         ----------
         guild_id: :class:`int`
-            The ID of the guild where the applcation command should be deleted.
+            The ID of the guild where the application command should be deleted.
         command_id: :class:`int`
             The ID of the application command to delete.
         """

disnake/ext/commands/converter.py

@@ -656,7 +656,7 @@ async def convert(self, ctx: AnyContext, argument: str) -> disnake.MediaChannel:
 
 
 class ThreadConverter(IDConverter[disnake.Thread]):
-    """Coverts to a :class:`~disnake.Thread`.
+    """Converts to a :class:`~disnake.Thread`.
 
     All lookups are via the local guild.
 

disnake/ext/commands/errors.py

@@ -537,7 +537,7 @@ def __init__(self, argument: str) -> None:
 
 
 class BadBoolArgument(BadArgument):
-    """Exception raised when a boolean argument was not convertable.
+    """Exception raised when a boolean argument was not convertible.
 
     This inherits from :exc:`BadArgument`
 

disnake/ext/commands/interaction_bot_base.py

@@ -881,7 +881,7 @@ async def _sync_application_commands(self) -> None:
             return
 
         # We assume that all commands are already cached.
-        # Sort all invokable commands between guild IDs:
+        # Sort all invocable commands between guild IDs:
         global_cmds, guild_cmds = self._ordered_unsynced_commands(self._test_guilds)
 
         if self._command_sync_flags.sync_global_commands:
@@ -1416,7 +1416,7 @@ async def process_application_commands(
                     # either malformed API request, or some other error
                     # in theory this will never error: if a command exists the bot has authorisation
                     # in practice this is not the case, the API could change valid requests at any time
-                    message = "This command could not be processed. Additionally, an error occured when trying to sync commands."
+                    message = "This command could not be processed. Additionally, an error occurred when trying to sync commands."
                 else:
                     message = "This command has just been synced."
             else:
@@ -1455,7 +1455,7 @@ async def process_application_commands(
             event_name = "message_command"
 
         if event_name is None or app_command is None:
-            # If we are here, the command being invoked is either unknown or has an unknonw type.
+            # If we are here, the command being invoked is either unknown or has an unknown type.
             # This usually happens if the auto sync is disabled, so let's just ignore this.
             return
 

disnake/ext/commands/params.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: MIT
 
-"""Repsonsible for handling Params for slash commands"""
+"""Responsible for handling Params for slash commands"""
 
 from __future__ import annotations
 

disnake/interactions/application_command.py

@@ -155,7 +155,7 @@ def __init__(
 
     @property
     def target(self) -> Optional[Union[User, Member, Message]]:
-        """Optional[Union[:class:`abc.User`, :class:`Message`]]: The user or message targetted by a user or message command"""
+        """Optional[Union[:class:`abc.User`, :class:`Message`]]: The user or message targeted by a user or message command"""
         return self.data.target
 
     @property
@@ -231,9 +231,9 @@ class ApplicationCommandInteractionData(Dict[str, Any]):
     options: List[:class:`ApplicationCommandInteractionDataOption`]
         A list of options from the API.
     target_id: :class:`int`
-        ID of the user or message targetted by a user or message command
+        ID of the user or message targeted by a user or message command
     target: Union[:class:`User`, :class:`Member`, :class:`Message`]
-        The user or message targetted by a user or message command
+        The user or message targeted by a user or message command
     """
 
     __slots__ = (

disnake/object.py

@@ -54,7 +54,7 @@ def __init__(self, id: SupportsIntCast) -> None:
             id = int(id)
         except ValueError:
             raise TypeError(
-                f"id parameter must be convertable to int not {id.__class__!r}"
+                f"id parameter must be convertible to int not {id.__class__!r}"
             ) from None
         else:
             self.id = id