[DATALAD RUNCMD] run codespell throughout fixing typos automagically

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

Author: yarikoptic

.github/ISSUE_TEMPLATE/feature.md

@@ -1,6 +1,6 @@
 ---
 name: Feature/improvement proposal
-about: Propose a new feauture or improvement for Read the Docs
+about: Propose a new feature or improvement for Read the Docs
 ---
 
 ## What's the problem this feature will solve?

.github/workflows/pip-tools.yaml

@@ -1,5 +1,5 @@
 # Action to run pip-compile weekly and create a Pull Request with the changes.
-# Althought GitHub says that pip-compile is supported by dependabot, we couldn't make it work together.
+# Although GitHub says that pip-compile is supported by dependabot, we couldn't make it work together.
 # That's why this action exists.
 # If we ever find the proper configuration for dependabot+pip-compile,
 # we can delete this action.

CHANGELOG.rst

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 
 # Options should be aligned with how the documentation is built on RTD
-# (except for '--keep-going', failing fast is prefered on local builds)
+# (except for '--keep-going', failing fast is preferred on local builds)
 # We also remove '-E' to reduce the time of rebuilding reference indexes
 # on each build.
 SPHINXOPTS    = -T -j auto -W

docs/Makefile

@@ -42,7 +42,7 @@ Instead of trying to map a URL to a view,
 we first analyze the root project (given from the subdomain),
 and based on that we map each part of the URL to the *current* project and version.
 
-This will allow us to re-use this code in our unresolver
+This will allow us to reuse this code in our unresolver
 without the need to override the Django's urlconf at runtime,
 or guessing a project only by the structure of its URL.
 

docs/dev/design/better-doc-urls-handling.rst

@@ -265,7 +265,7 @@ and we can roll back if the new pre-compiled version was built with a problem.
 
    Installing always the latest version is harder to maintain.
    It will require building the newest version each time a new patch version is released.
-   Beacause of that, Read the Docs will always be behind official releases.
+   Because of that, Read the Docs will always be behind official releases.
    Besides, it will give projects different versions more often.
 
    Exposing to the user the patch version would require to cache many different versions ourselves,
@@ -424,10 +424,10 @@ that doesn't seem to be useful to have the same OS version with different states
 Allowing users to install extra languages by using the Config File will cover most of the support requests we have had in the past.
 It also will allow us to know more about how our users are using the platform to make future decisions based on this data.
 Exposing users how we want them to use our platform will allow us to be able to maintain it longer,
-than giving the option to select a specific Docker image by name that we can't guarrantee it will be frozen.
+than giving the option to select a specific Docker image by name that we can't guarantee it will be frozen.
 
 Finally, having the ability to deprecate and *remove* pre-built images from our builders over time,
-will reduce the maintainance work required from the the core team.
+will reduce the maintenance work required from the the core team.
 We can always support all the languages versions by installing them at build time.
 The only required pre-built image for this are the OS ``-base`` images.
 In fact, even after decided to deprecate and removed a pre-built image from the builders,

docs/dev/design/build-images.rst

@@ -34,7 +34,7 @@ Goals
 * Ability to add non-error notifications from the build process
 * Add extra metadata associated to the notification: icon, header, body, etc
 * Support different types of notifications (e.g. error, warning, note, tip)
-* Re-use the new notification system for product updates (e.g. new features, deprecated config keys)
+* Reuse the new notification system for product updates (e.g. new features, deprecated config keys)
 * Message content lives on Python classes that can be translated and formatted with objects (e.g. Build, Project)
 * Message could have richer content (e.g. HTML code) to generate links and emphasis
 * Notifications have trackable state (e.g. unread (default)=never shown, read=shown, dismissed=don't show again, cancelled=auto-removed after user action)
@@ -43,7 +43,7 @@ Goals
 * Notifications can be attached to Project, Organization, Build and User models
 * Specific notifications can be shown under the user's bell icon
 * Easy way to cleanup notification on status changes (e.g. subscription failure notification is auto-deleted after CC updated)
-* Notifications attached to Organization/Project dissappear for all the users once they are dismissed by anyone
+* Notifications attached to Organization/Project disappear for all the users once they are dismissed by anyone
 
 
 Non-goals
@@ -88,7 +88,7 @@ This section shows all the classes and models involved for the notification syst
 .. note:: Accessing the database from the build process
 
     Builders doesn't have access to the database due to security reasons.
-    We had solved this limitation by creating an API endpoint the builder hits once they need to interact with the databse to get a ``Project``, ``Version`` and ``Build`` resources, create a ``BuildCommand`` resource, etc.
+    We had solved this limitation by creating an API endpoint the builder hits once they need to interact with the database to get a ``Project``, ``Version`` and ``Build`` resources, create a ``BuildCommand`` resource, etc.
 
     Besides, the build process is capable to trigger Celery tasks that are useful for managing more complex logic
     that also require accessing from and writing to the database.
@@ -116,7 +116,7 @@ and some helper logic to return in the API response.
             body = str
             icon = str
             icon_style = str(SOLID, DUOTONE)
-            type = str(ERROR, WARINIG, NOTE, TIP)
+            type = str(ERROR, WARNING, NOTE, TIP)
 
         def get_display_icon(self):
             if self.icon:
@@ -201,7 +201,7 @@ It contains an identifier (``message_id``) pointing to one of the messages defin
         message_id = models.CharField(max_length=128)
 
         # UNREAD: the notification was not shown to the user
-        # READ: the notifiation was shown
+        # READ: the notification was shown
         # DISMISSED: the notification was shown and the user dismissed it
         # CANCELLED: removed automatically because the user has done the action required (e.g. paid the subscription)
         state = models.CharField(
@@ -210,7 +210,7 @@ It contains an identifier (``message_id``) pointing to one of the messages defin
             db_index=True,
         )
 
-        # Makes the notification imposible to dismiss (useful for Build notifications)
+        # Makes the notification impossible to dismiss (useful for Build notifications)
         dismissable = models.BooleanField(default=False)
 
         # Show the notification under the bell icon for the user

docs/dev/design/new-notifications-system.rst

@@ -139,7 +139,7 @@ like the projects, versions, and the query that were used in the final search.
 And the ``version``, ``project``, and ``project_alias`` attributes will
 now be objects.
 
-We could just re-use the old response too,
+We could just reuse the old response too,
 since the only breaking changes would be the attributes now being objects,
 and we aren't adding any new information to those objects (yet).
 But also, re-using the current serializers shouldn't be a problem either.
@@ -230,7 +230,7 @@ the readthedocs.org/readthedocs.com domains.
 We have two types:
 
 Project scoped search:
-   Search files and versions of the curent project only.
+   Search files and versions of the current project only.
 
 Global search:
    Search files and versions of all projects in .org,

docs/dev/design/new-search-api.rst

@@ -43,7 +43,7 @@ We might consider adding a ``VERSION_TYPES`` to the ``Version`` model.
 - If we go with ``VERSION_TYPES`` we can add something like ``pull_request`` alongside Tag and Branch.
 
 We should add ``Version`` and ``Build`` Model Managers for PR and Regular Versions and Builds.
-The proposed names for PR and Regular Version and Build Mangers are ``external`` and ``internal``.
+The proposed names for PR and Regular Version and Build Managers are ``external`` and ``internal``.
 
 We can then use ``Version.internal.all()`` to get all regular versions,
 ``Version.external.all()`` to get all PR versions.

docs/dev/design/pr-builder.rst

@@ -98,7 +98,7 @@ Why attach tokens to users?
 ---------------------------
 
 Attaching tokens to users will ease the implementation,
-since we can re-use the code from knox package.
+since we can reuse the code from knox package.
 
 Attaching tokens to projects only is possible,
 but it will require to manage the authentication manually.
@@ -108,7 +108,7 @@ An alternative is to use the DRF API key package, which doesn't require a user,
 but then if we wanted to extend this functionality to our normal APIs, we will have
 to implement the authentication manually.
 
-Kepping backwards compatibility
+Keeping backwards compatibility
 -------------------------------
 
 Access to write API V2 is restricted to superusers,
@@ -161,7 +161,7 @@ since it also handles authentication).
 Decision
 --------
 
-Due to the fact that the required featues from knox are not released yet,
+Due to the fact that the required features from knox are not released yet,
 we have decided to use DRF API key instead.
 
 Future work

docs/dev/design/secure-api-access-from-builders.rst

@@ -74,7 +74,7 @@ and it's manually created by the RTD core team.
 To create a custom plan, you need to create a new product in Stripe,
 and add the product id to the ``RTD_PRODUCTS`` setting mapped to the features that the plan will provide.
 After that, you can create a subscription for the organization with the custom product,
-our appliction will automatically relate this new product to the organization.
+our application will automatically relate this new product to the organization.
 
 Extra products
 --------------
@@ -87,4 +87,4 @@ extra product will provide, this product should have the ``extra`` attribute set
 
 To subscribe an organization to an extra product,
 you just need to add the product to its subscription with the desired quantity,
-our appliction will automatically relate this new product to the organization.
+our application will automatically relate this new product to the organization.

docs/dev/subscriptions.rst

@@ -1876,7 +1876,7 @@ Remote repository listing
     The ``results`` in response is an array of remote repositories data.
 
     :query string name: return remote repositories containing the name
-    :query string full_name: return remote repositories containing the full name (it inclues the username/organization the project belongs to)
+    :query string full_name: return remote repositories containing the full name (it includes the username/organization the project belongs to)
     :query string vcs_provider: return remote repositories for specific vcs provider (``github``, ``gitlab`` or ``bitbucket``)
     :query string organization: return remote repositories for specific remote organization (using remote organization ``slug``)
     :query string expand: allows to add/expand some extra fields in the response.

docs/user/api/v3.rst

@@ -94,7 +94,7 @@ Read the Docs supports three different mechanisms to cancel a running build:
    When Read the Docs detects a push to a version that is already building,
    it cancels the running build and starts a new build using the latest commit.
 
-:Programatically:
+:Programmatically:
 
    You can use user-defined commands on ``build.jobs`` or ``build.commands`` (see :doc:`build-customization`)
    to check for your own cancellation condition and then return exit code ``183`` to cancel a build.

docs/user/builds.rst

@@ -325,7 +325,7 @@ According to `its own documentation <https://jupyterbook.org/>`_,
 
 Even though `Jupyter Book leverages Sphinx "for almost everything that it
 does" <https://jupyterbook.org/explain/sphinx.html#jupyter-book-is-a-distribution-of-sphinx>`_,
-it purposedly hides Sphinx ``conf.py`` files from the user,
+it purposely hides Sphinx ``conf.py`` files from the user,
 and instead generates them on the fly from its declarative ``_config.yml``.
 As a result, you need to follow some extra steps
 to make Jupyter Book work on Read the Docs.

docs/user/faq.rst

@@ -88,7 +88,7 @@ so that you have a reference for how we're using them.
       Another name for :term:`project home`.
 
    reproducible
-      A documentation project is said to be *reproducible* when its sources build correctly on Read the Docs over a periode of many years.
+      A documentation project is said to be *reproducible* when its sources build correctly on Read the Docs over a period of many years.
       You can also think of being *reproducible* as being *robust* or *resillient*.
 
       Being "reproducible" is an important positive quality goal of documentation.

docs/user/glossary.rst

@@ -86,7 +86,7 @@ No new builds are started when I open a pull request
 Build status is not being reported to your Git provider
    If opening a pull request does start a new build, but the build status is not
    being updated with your Git provider, then your connected account may have out
-   dated or insufficient permisisons.
+   dated or insufficient permissions.
 
    Make sure that you have granted access to the Read the Docs `OAuth App`_ for
    your personal or organization GitHub account. You can also try reconnecting

docs/user/guides/pull-requests.rst

@@ -86,7 +86,7 @@ See our :doc:`/config-file/index` docs for more details.
    Using a configuration file :doc:`is required from September 2023 <rtd-blog:migrate-configuration-v2>`.
 
 It is also important to note that the default version of Sphinx is ``v1.8.5``.
-We recommend to set the version your project uses :doc:`explicitily with pinned dependencies </guides/reproducible-builds>`.
+We recommend to set the version your project uses :doc:`explicitly with pinned dependencies </guides/reproducible-builds>`.
 
 Read the Docs will host multiple versions of your code. You can read more about
 how to use this well on our :doc:`/versions` page.

docs/user/intro/import-guide.rst

@@ -130,7 +130,7 @@ Here are some popular activities that are well-supported by Jupyter Book:
 Ready to get started?
 """""""""""""""""""""
 
-.. Note that this is a deliberate repitition of a previous segment. Should it repeat? Maybe not, but for now it's nice to be sure that people see it.
+.. Note that this is a deliberate repetition of a previous segment. Should it repeat? Maybe not, but for now it's nice to be sure that people see it.
 
 * All new to this? Take the official :external+jupyterbook:doc:`Jupyter Book Tutorial » <start/your-first-book>`
 * Curious for practical code? See the list of :doc:`example projects » </examples>`

docs/user/science.rst

@@ -153,7 +153,7 @@ with the following changes:
 
 When searching on a parent project,
 results from their subprojects won't be included automatically,
-to include results from subprojects use the ``subprojects`` paramater.
+to include results from subprojects use the ``subprojects`` parameter.
 
 Authentication and authorization
 --------------------------------

docs/user/server-side-search/api.rst

@@ -206,7 +206,7 @@ If you now click on :guilabel:`View docs`, you will see your documentation live!
 
    If you don't see the ad, you might be using an ad blocker.
    Our EthicalAds network respects your privacy, doesn't target you,
-   and tries to be as unobstrusive as possible,
+   and tries to be as unobtrusive as possible,
    so we would like to kindly ask you to :doc:`not block us </advertising/ad-blocking>` |:heart:|
 
 Basic configuration changes

docs/user/tutorial/index.rst

@@ -309,7 +309,7 @@ def get_closed_external_version_response(self, project):
 
     def update_default_branch(self, default_branch):
         """
-        Update the `Version.identifer` for `latest` with the VCS's `default_branch`.
+        Update the `Version.identifier` for `latest` with the VCS's `default_branch`.
 
         The VCS's `default_branch` is the branch cloned when there is no specific branch specified
         (e.g. `git clone <URL>`).

readthedocs/api/v2/views/integrations.py

@@ -156,7 +156,7 @@ def get_queryset(self):
         If an API key is present, we filter by the project associated with the key.
         Otherwise, we filter using our API manager method.
 
-        With this we check if the user/api key is authorized to acccess the object.
+        With this we check if the user/api key is authorized to access the object.
         """
         api_key = getattr(self.request, "build_api_key", None)
         if api_key:
@@ -247,7 +247,7 @@ def get_serializer_class(self):
         """
         Return the proper serializer for UI and Admin.
 
-        This ViewSet has a sligtly different pattern since we want to
+        This ViewSet has a slightly different pattern since we want to
         pre-process the `command` field before returning it to the user, and we
         also want to have a specific serializer for admins.
         """

readthedocs/api/v2/views/model_views.py

@@ -575,7 +575,7 @@ def _validate_remote_repository(self, data):
         Validate connection between `Project` and `RemoteRepository`.
 
         We don't do anything in community, but we do ensure this relationship
-        is posible before creating the `Project` on commercial when the
+        is possible before creating the `Project` on commercial when the
         organization has VCS SSO enabled.
 
         If we cannot ensure the relationship here, this method should raise a

readthedocs/api/v3/serializers.py

@@ -66,7 +66,7 @@ class Migration(migrations.Migration):
                     "action_arg",
                     models.CharField(
                         blank=True,
-                        help_text="Value used for the action to perfom an operation",
+                        help_text="Value used for the action to perform an operation",
                         max_length=255,
                         null=True,
                         verbose_name="Action argument",

readthedocs/builds/migrations/0007_add-automation-rules.py

@@ -892,7 +892,7 @@ def config(self):
         """
         # TODO: now that we are using a proper JSONField here, we could
         # probably change this field to be a ForeignKey to avoid repeating the
-        # config file over and over again and re-use them to save db data as
+        # config file over and over again and reuse them to save db data as
         # well
         if self._config and self.CONFIG_KEY in self._config:
             return (
@@ -1116,7 +1116,7 @@ class BuildCommandResultMixin:
     Mixin for common command result methods/properties.
 
     Shared methods between the database model :py:class:`BuildCommandResult` and
-    non-model respresentations of build command results from the API
+    non-model representations of build command results from the API
     """
 
     @property
@@ -1236,7 +1236,7 @@ class VersionAutomationRule(PolymorphicModel, TimeStampedModel):
     )
     action_arg = models.CharField(
         _("Action argument"),
-        help_text=_("Value used for the action to perfom an operation"),
+        help_text=_("Value used for the action to perform an operation"),
         max_length=255,
         null=True,
         blank=True,

readthedocs/builds/models.py

@@ -112,7 +112,7 @@ def slugify(self, content):
             space_replacement="-",
         )
 
-        # Remove first character wile it's an invalid character for the
+        # Remove first character while it's an invalid character for the
         # beginning of the slug
         slugified = slugified.lstrip(self.ok_chars)
 

readthedocs/builds/version_slug.py

@@ -530,7 +530,7 @@ def validate_doc_types(self):
         Validates that the user only have one type of documentation.
 
         This should be called before validating ``sphinx`` or ``mkdocs`` to
-        avoid innecessary validations.
+        avoid unnecessary validations.
         """
         with self.catch_validation_error("."):
             if "sphinx" in self._raw_config and "mkdocs" in self._raw_config:

readthedocs/config/config.py

@@ -142,7 +142,7 @@
         body=_(
             textwrap.dedent(
                 """
-            The name of the package <code>{{pacakge}}</name> is invalid.
+            The name of the package <code>{{package}}</name> is invalid.
             """
             ).strip(),
         ),

readthedocs/config/notifications.py

@@ -21,5 +21,5 @@ def clear_cache():
     """
     # Code run before each test
     yield
-    # Code run afer each test
+    # Code run after each test
     cache.clear()