[DATALAD RUNCMD] chore: run codespell throughout fixing a few typos interactively

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 4",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Author: yarikoptic

readthedocs/api/v2/views/model_views.py

@@ -452,7 +452,7 @@ class NotificationViewSet(DisableListEndpoint, CreateModelMixin, UserSelectViewS
 
     This endpoint is currently used only internally by the builder.
     Notifications are attached to `Build` objects only when using this endpoint.
-    This limitation will change in the future when re-implementing this on APIv3 if neeed.
+    This limitation will change in the future when re-implementing this on APIv3 if needed.
     """
 
     parser_classes = [JSONParser, MultiPartParser]

readthedocs/api/v3/permissions.py

@@ -8,7 +8,7 @@ class HasEmbedAPIAccess(BasePermission):
     """
     Check if the project being accessed has access to the Embed API.
 
-    The embedded API V3 allows getting content from external sites tha
+    The embedded API V3 allows getting content from external sites that
     aren't attached to a project. Those sites are restricted to the ones
     from ``RTD_EMBED_API_EXTERNAL_DOMAINS``, so we just allow that.
     """

readthedocs/core/middleware.py

@@ -14,7 +14,7 @@ class NullCharactersMiddleware:
     when trying to save the content containing a NULL character into the
     database, producing a 500 and creating an event in Sentry.
 
-    NULL characters are also used as an explotation technique, known as "Null Byte Injection".
+    NULL characters are also used as an exploitation technique, known as "Null Byte Injection".
     """
 
     def __init__(self, get_response):

readthedocs/core/utils/__init__.py

@@ -390,7 +390,7 @@ def extract_valid_attributes_for_model(model, attributes):
     attributes = attributes.copy()
     valid_field_names = {field.name for field in model._meta.get_fields()}
     valid_attributes = {}
-    # We can't change a dictionary while interating over its keys,
+    # We can't change a dictionary while iterating over its keys,
     # so we make a copy of its keys.
     keys = list(attributes.keys())
     for key in keys:

readthedocs/doc_builder/backends/sphinx.py

@@ -44,7 +44,7 @@ def __init__(self, *args, **kwargs):
         # `absolute_host_output_dir` because it's not defined in the host. So,
         # we have to re-calculate its value. We will remove this limitation
         # when we execute the whole building from inside the Docker container
-        # (instead behing a hybrid as it is now)
+        # (instead being a hybrid as it is now)
         #
         # We need to have two different paths that point to the exact same
         # directory. How is that? The directory is mounted into a different
@@ -95,7 +95,7 @@ def __init__(self, *args, **kwargs):
             #
             # IMO, if there are multiple config files,
             # the build should fail immediately communicating this to the user.
-            # This can be achived by unhandle the exception here
+            # This can be achieved by unhandle the exception here
             # and leaving `on_failure` Celery handle to deal with it.
             #
             # In case there is no config file, we should continue the build
@@ -152,7 +152,7 @@ def build(self):
                 f"language={language}",
                 # Sphinx's source directory (SOURCEDIR).
                 # We are executing this command at the location of the `conf.py` file (CWD).
-                # TODO: ideally we should execute it from where the repository was clonned,
+                # TODO: ideally we should execute it from where the repository was cloned,
                 # but that could lead unexpected behavior to some users:
                 # https://github.com/readthedocs/readthedocs.org/pull/9888#issuecomment-1384649346
                 ".",
@@ -321,7 +321,7 @@ def build(self):
             f"language={language}",
             # Sphinx's source directory (SOURCEDIR).
             # We are executing this command at the location of the `conf.py` file (CWD).
-            # TODO: ideally we should execute it from where the repository was clonned,
+            # TODO: ideally we should execute it from where the repository was cloned,
             # but that could lead unexpected behavior to some users:
             # https://github.com/readthedocs/readthedocs.org/pull/9888#issuecomment-1384649346
             ".",

readthedocs/projects/models.py

@@ -905,7 +905,7 @@ def get_downloads(self):
 
     @property
     def clean_repo(self):
-        # NOTE: this method is used only when the project is going to be clonned.
+        # NOTE: this method is used only when the project is going to be cloned.
         # It probably makes sense to do a data migrations and force "Import Project"
         # form to validate it's an HTTPS URL when importing new ones
         if self.repo.startswith("http://github.com"):

readthedocs/projects/tasks/builds.py

@@ -789,7 +789,7 @@ def update_build(self, state=None):
             log.exception("Error while updating the build object.", state=state)
 
     def execute(self):
-        # Clonning
+        # Cloning
         self.update_build(state=BUILD_STATE_CLONING)
 
         # TODO: remove the ``create_vcs_environment`` hack. Ideally, this should be

readthedocs/projects/tasks/search.py

@@ -159,7 +159,7 @@ def _get_indexers(*, version: Version, build: Build, search_index_name=None):
     indexers = []
     # NOTE: The search indexer must be before the index file indexer.
     # This is because saving the objects in the DB will give them an id,
-    # and we neeed this id to be `None` when indexing the objects in ES.
+    # and we need this id to be `None` when indexing the objects in ES.
     # ES will generate a unique id for each document.
     # NOTE: If the version is external, we don't create a search index for it.
     if not version.is_external:

readthedocs/projects/tests/test_build_tasks.py

@@ -1401,7 +1401,7 @@ def test_build_commands_executed_with_clone_token(
         os.makedirs(self.project.artifact_path(version=self.version.slug, type_="epub"))
         os.makedirs(self.project.artifact_path(version=self.version.slug, type_="pdf"))
 
-        get_clone_token.return_value = "toke:1234"
+        get_clone_token.return_value = "token:1234"
         github_app_installation = get(
             GitHubAppInstallation,
             installation_id=1234,

readthedocs/projects/version_handling.py

@@ -106,7 +106,7 @@ def sort_versions(version_list):
 
     :returns: sorted list in descending order (latest version first) of versions
 
-    :rtype: list(tupe(readthedocs.builds.models.Version,
+    :rtype: list(tuple(readthedocs.builds.models.Version,
             packaging.version.Version))
     """
     versions = []