Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos discovered by codespell in /docs #8409

Merged
merged 1 commit into from
Aug 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api/v3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Projects list
"home": "https://pip.pypa.io/"
},
"tags": [
"disutils",
"distutils",
"easy_install",
"egg",
"setuptools",
Expand Down Expand Up @@ -259,7 +259,7 @@ Project details
"home": "https://pip.pypa.io/"
},
"tags": [
"disutils",
"distutils",
"easy_install",
"egg",
"setuptools",
Expand Down Expand Up @@ -917,7 +917,7 @@ Subproject create
:>json string alias: optional slug alias to be used in the URL (e.g ``/projects/<alias>/en/latest/``).
If not provided, child project's slug is used as alias.

:statuscode 201: Subproject created sucessfully
:statuscode 201: Subproject created successfully


Subproject delete
Expand Down Expand Up @@ -1015,7 +1015,7 @@ Translations listing
"home": "https://pip.pypa.io/"
},
"tags": [
"disutils",
"distutils",
"easy_install",
"egg",
"setuptools",
Expand Down
2 changes: 1 addition & 1 deletion docs/commercial/sharing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Once the person you send the link to clicks the link,
they will have access to the documentation while their browser window is open.

If you want to link to a specific page,
you can do this by passing the ``next`` query paramater in the URL.
you can do this by passing the ``next`` query parameter in the URL.
For example ``https://mydocs.readthedocs-hosted.com/_/sharing/xxxxxxxxx?next=/en/latest/page.html``.

.. tip::
Expand Down
2 changes: 1 addition & 1 deletion docs/development/design/apiv3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Goals
Non-Goals
---------

* Filter by arbitrary and non-useful fields
* Filter by arbitrary and useless fields

* "Builds with ``exit_code=1``"
* "Builds containing ``ERROR`` on their output"
Expand Down
2 changes: 1 addition & 1 deletion docs/development/design/build-images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Non goals
---------

* allow creation/usage of custom Docker images
* allow to execute arbitraty commands via hooks (eg. ``pre_build``)
* allow to execute arbitrary commands via hooks (eg. ``pre_build``)


New build image structure
Expand Down
4 changes: 2 additions & 2 deletions docs/development/design/embed-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ and replace all the relative links from its content making them absolute.
Any other case outside this contract will be considered *special* and will be implemented
only under ``?doctool=``, ``?version=`` and ``?writer=`` arguments.

If no ``id`` selector is sent to the request, the content of the first meaningfull HTML tag
If no ``id`` selector is sent to the request, the content of the first meaningful HTML tag
(``<main>``, ``<div role="main">`` or other well-defined standard tags) identifier found is returned.


Expand Down Expand Up @@ -221,7 +221,7 @@ The whole logic should be the same, the only difference would be where the sourc

.. warning::

We should be carefull with the URL received from the user because those may be internal URLs and we could be leaking some data.
We should be careful with the URL received from the user because those may be internal URLs and we could be leaking some data.
Example: ``?url=http://localhost/some-weird-endpoint`` or ``?url=http://169.254.169.254/latest/meta-data/``
(see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html).

Expand Down
4 changes: 2 additions & 2 deletions docs/development/search-integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Sections

Sections are ``h`` tags, and sections of the same level should be neighbors.
Additionally, sections should have an unique ``id`` attribute per page (this is used to link to the section).
All content bellow the section, till the new section will be indexed as part of the section. Example:
All content below the section, till the new section will be indexed as part of the section. Example:

.. code-block:: html
:emphasize-lines: 2-10
Expand Down Expand Up @@ -124,7 +124,7 @@ All content bellow the section, till the new section will be indexed as part of

Sections can be inside till two nested tags (and have nested sections),
and its immediate parent can contain the ``id`` attribute.
Note that the section content still needs to be bellow the ``h`` tag. Example:
Note that the section content still needs to be below the ``h`` tag. Example:

.. code-block:: html
:emphasize-lines: 3-11,14-21
Expand Down
2 changes: 1 addition & 1 deletion docs/gsoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Build a new Sphinx theme

Sphinx v2 will introduce a new format for themes,
supporting HTML5 and new markup.
We are hoping to buid a new Sphinx theme that supports this new structure.
We are hoping to build a new Sphinx theme that supports this new structure.

This project would include:

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/conda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ conda also needs to know which channels to use, and which ones take precedence.
If not specified, conda will use ``defaults``, the channel maintained by Anaconda Inc.
and subject to `Anaconda Terms of Service`_. It contains well-tested versions of the most widely used
packages. However, some packages are not available on the ``defaults`` channel,
and even if they are, they might not be on their lastest versions.
and even if they are, they might not be on their latest versions.

As an alternative, there are channels maintained by the community that have a broader selection
of packages and more up-to-date versions of them, the most popular one being ``conda-forge``.
Expand Down Expand Up @@ -108,7 +108,7 @@ Mixing conda and pip packages
-----------------------------

There are valid reasons to use pip inside a conda environment: some dependency
might not be avaliable yet as a conda package in any channel,
might not be available yet as a conda package in any channel,
or you might want to avoid precompiled binaries entirely.
In either case, it is possible to specify the subset of packages
that will be installed with pip in the ``environment.yml`` file. For example:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/deprecating-content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ For example:
ranking:
api/v1.html: -1

This wont hide results from that page, but it will give priority to results from other pages.
This won't hide results from that page, but it will give priority to results from other pages.

.. TODO: mention search.ignore when it's implemented.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/private-python-packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ See :doc:`using environment variables in Read the Docs </guides/environment-vari
and including a dollar sign and curly brackets around the name (``${API_TOKEN}``)
for :ref:`pip to be able to recognize them <pip:using environment variables>`.

Bellow you can find how to get a personal access token from our supported providers.
Below you can find how to get a personal access token from our supported providers.
We will be using environment variables for the token.

GitHub
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/searching-with-readthedocs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Example queries:

- https://docs.readthedocs.io/?rtd_search=reedthedcs~2
- https://docs.readthedocs.io/?rtd_search=authentation~3
- https://docs.readthedocs.io/?rtd_search=configurtion~1
- https://docs.readthedocs.io/?rtd_search=configuration~1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this was actually meant to be mispelled :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woops, didn't notice that one, sorry

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverting in #8419



Build complex queries
Expand Down
2 changes: 1 addition & 1 deletion docs/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ release number.

Group milestones are blocks of work that will have priority in the future, but
aren't included on point releases yet. When the core team does decide to make
these milestones a priorty, they will be moved into point release milestones.
these milestones a priority, they will be moved into point release milestones.

.. _semantic versioning: https://semver.org

Expand Down
2 changes: 1 addition & 1 deletion docs/webhooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ In addition to :ref:`no longer supporting GitHub Services <webhook-github-servic
we have decided to no longer support several other legacy incoming webhook
endpoints that were used before we introduced project webhook integrations. When
we introduced our webhook integrations, we added several features and improved
security for incoming webhooks and these features were not added to our leagcy
security for incoming webhooks and these features were not added to our legacy
incoming webhooks. New projects have not been able to use our legacy incoming
webhooks since, however if you have a project that has been established for a
while, you may still be using these endpoints.
Expand Down