Skip to content

Commit c5202bd

Browse files
committed
[DATALAD RUNCMD] chore: run codespell throughout fixing a few new typos automagically
=== Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^
1 parent 28527bf commit c5202bd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+70
-70
lines changed

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Feature/improvement proposal
3-
about: Propose a new feauture or improvement for Read the Docs
3+
about: Propose a new feature or improvement for Read the Docs
44
---
55

66
## What's the problem this feature will solve?

docs/dev/aws-temporary-credentials.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ AWS temporary credentials
22
=========================
33

44
Builders run arbitrary commands provided by the user, while we run the commands in a sandboxed environment (docker),
5-
that shouln't be the only line of defense, as we still interact with the files generated by the user outside docker for some operations.
5+
that shouldn't be the only line of defense, as we still interact with the files generated by the user outside docker for some operations.
66

77
This is why instead of using credentials that have access to all the resources in AWS,
88
we are using credentials that are generated by the `AWS STS service <https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html>`__,

docs/dev/design/build-images.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ on each image without asking the users to change the image selected in their con
3939
Then, when a completely different image appeared and after testing ``testing`` image enough,
4040
we discarded ``stable``, old ``latest`` became the new ``stable`` and old ``testing`` became the new ``latest``.
4141
This produced issues to people pinning their images to any of these names because after this change,
42-
*we changed all the images for all the users* and many build issues arrised!
42+
*we changed all the images for all the users* and many build issues arose!
4343

4444

4545
Goals

docs/dev/design/future-builder.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,6 @@ Final notes
256256
- the project/build/user to expose a ``metadata.yaml`` with the contract that Read the Docs expects.
257257
- none, some or all the integrations will be added to the HTML output (these have to be implemented at Read the Docs core)
258258
- We are not responsible for extra formats (e.g. PDF, ePub, etc) on other tools.
259-
- Focus on support Sphinx with nice integrations made in a tool-agnostic way that can be re-used.
259+
- Focus on support Sphinx with nice integrations made in a tool-agnostic way that can be reused.
260260
- Removing the manipulation of ``conf.py.tmpl`` does not require us to implement the same manipulation
261261
for projects using the new potential feature ``sphinx.yaml`` file.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ now be objects.
142142
We could just reuse the old response too,
143143
since the only breaking changes would be the attributes now being objects,
144144
and we aren't adding any new information to those objects (yet).
145-
But also, re-using the current serializers shouldn't be a problem either.
145+
But also, reusing the current serializers shouldn't be a problem either.
146146

147147
.. code-block:: json
148148

docs/dev/github-app.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ GitHub App
44
Our GitHub App integration consists of a GitHub App (one for each platform, readthedocs.org and readthedocs.com),
55
which can be installed on a user's account or organization.
66

7-
After installing the GitHub App, users can grant acccess to all repositories or select specific repositories,
7+
After installing the GitHub App, users can grant access to all repositories or select specific repositories,
88
this allows Read the Docs to access the repositories and perform actions on them, such as reporting build statuses,
99
and subscribe to events like push and pull request events.
1010

@@ -42,5 +42,5 @@ Security
4242
- Since we make use of the installation to perform actions on the repositories instead of the user's OAuth2 token,
4343
we make sure that only users with admin permissions on the repository can link the repository to a Read the Docs project.
4444
- Once we lose access to a repository (e.g. the installation is uninstalled or revoked, or the project was deselected from the installation),
45-
we remove the remote repository from the database, as we don't want to keep the relation bettween the project and the repository.
45+
we remove the remote repository from the database, as we don't want to keep the relation between the project and the repository.
4646
This is to prevent connecting the repository to the project again without the user's consent if they grant access to the repository again.

docs/user/guides/creating-project-private-repository.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Configuring repository webhooks
147147
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
148148

149149
Your repository will also need to be configured to push updates via webhooks to Read the Docs on repository events.
150-
Webhook updates are used to automatically trigger new builds for your project and syncronize your repository's branches and tags.
150+
Webhook updates are used to automatically trigger new builds for your project and synchronize your repository's branches and tags.
151151

152152
This step is the same for public repositories,
153153
follow the directions for :doc:`manually configuring a Git repository integration </guides/setup/git-repo-manual>`.

docs/user/img/screenshots/business.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
output: business-project-manual-team-select.png
1313

1414
# Project manual creation form, have to submit with a team first. The JS looks
15-
# funny becuase Playwright needs to wait for the page to load before submitting.
15+
# funny because Playwright needs to wait for the page to load before submitting.
1616
- url: https://app.readthedocs.com/dashboard/import/manual/
1717
javascript: |-
1818
const _submit = () => {

readthedocs/api/v2/views/integrations.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ def get_closed_external_version_response(self, project):
313313

314314
def update_default_branch(self, default_branch):
315315
"""
316-
Update the `Version.identifer` for `latest` with the VCS's `default_branch`.
316+
Update the `Version.identifier` for `latest` with the VCS's `default_branch`.
317317
318318
The VCS's `default_branch` is the branch cloned when there is no specific branch specified
319319
(e.g. `git clone <URL>`).

readthedocs/api/v2/views/model_views.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ def get_queryset(self):
173173
If an API key is present, we filter by the project associated with the key.
174174
Otherwise, we filter using our API manager method.
175175
176-
With this we check if the user/api key is authorized to acccess the object.
176+
With this we check if the user/api key is authorized to access the object.
177177
"""
178178
api_key = getattr(self.request, "build_api_key", None)
179179
if api_key:
@@ -263,7 +263,7 @@ def get_serializer_class(self):
263263
"""
264264
Return the proper serializer for UI and Admin.
265265
266-
This ViewSet has a sligtly different pattern since we want to
266+
This ViewSet has a slightly different pattern since we want to
267267
pre-process the `command` field before returning it to the user, and we
268268
also want to have a specific serializer for admins.
269269
"""
@@ -370,7 +370,7 @@ def retrieve(self, *args, **kwargs):
370370
methods=["post"],
371371
)
372372
def reset(self, request, **kwargs):
373-
"""Reset the build so it can be re-used when re-trying."""
373+
"""Reset the build so it can be reused when re-trying."""
374374
instance = self.get_object()
375375
instance.reset()
376376
return Response(status=status.HTTP_204_NO_CONTENT)

0 commit comments

Comments
 (0)