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 some typos in docs and code #4646

Merged
merged 1 commit into from
Sep 19, 2018
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
2 changes: 1 addition & 1 deletion docs/api/v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Doc Search
It returns data in the format of Elastic Search,
which requires a bit of traversing to use.

In the future we might change the format of this endpoint to make it more abstact.
In the future we might change the format of this endpoint to make it more abstract.

An example URL: https://readthedocs.org/api/v2/docsearch/?project=docs&version=latest&q=subdomains

Expand Down
2 changes: 1 addition & 1 deletion docs/builds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ we will first look for a ``mkdocs.yml`` file in the root of your repository.
If we don't find one,
we will generate one for you.

Then MkDocs will build any files with a ``.md`` extension within the directory specifed as ``docs_dir`` in the ``mkdocs.yml``.
Then MkDocs will build any files with a ``.md`` extension within the directory specified as ``docs_dir`` in the ``mkdocs.yml``.

If no ``mkdocs.yml`` was found in the root of your repository and we generated one for you,
Read the Docs will attempt to set ``docs_dir`` by sequentially searching for a ``docs``, ``doc``, ``Doc``, or ``book`` directory.
Expand Down
4 changes: 2 additions & 2 deletions docs/design/yaml-file.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
YAML Configuration File
=======================

Backgroud
---------
Background
----------

The current YAML configuration file is in beta state.
There are many options and features that it doesn't support yet.
Expand Down
4 changes: 2 additions & 2 deletions docs/gsoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Currently we have our documentation & website translated on Transifex,
but we don't have a management process for it.
This means that translations will often sit for months before making it back into the site and being available to users.

This project would include puting together a workflow for translations:
This project would include putting together a workflow for translations:

* Communicate with existing translators and see what needs they have
* Help formalize the process that we have around Transifex to make it easier to contribute to
Expand All @@ -119,7 +119,7 @@ Support for additional build steps for linting & testing

Currently we only build documentation on Read the Docs,
but we'd also like to add additional build steps that lets users perform more actions.
This would likely take the form of wraping some of the existing `Sphinx builders <http://www.sphinx-doc.org/en/stable/builders.html>`_,
This would likely take the form of wrapping some of the existing `Sphinx builders <http://www.sphinx-doc.org/en/stable/builders.html>`_,
and giving folks a nice way to use them inside Read the Docs.

It would be great to have wrappers for the following as a start:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/manage-translations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ This command will leave the ``.po`` files needed for building the documentation
.. warning::

It's important to use always the same method to translate the documentation and do not mix them.
Otherwise, it's very easy to end up with inconsistent translations or loosing already translated text.
Otherwise, it's very easy to end up with inconsistent translations or losing already translated text.


Build the documentation in target language
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/config/tests/test_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@


def test_apply_fs_with_empty_contents(tmpdir):
# Doesn't do anything if second paramter is empty.
# Doesn't do anything if second parameter is empty.
apply_fs(tmpdir, {})
assert tmpdir.listdir() == []

Expand Down
2 changes: 1 addition & 1 deletion readthedocs/core/symlink.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ def symlink_subprojects(self):
subprojects = set()
rels = self.get_subprojects()
if rels.count():
# Don't creat the `projects/` directory unless subprojects exist.
# Don't create the `projects/` directory unless subprojects exist.
if not os.path.exists(self.subproject_root):
safe_makedirs(self.subproject_root)
for rel in rels:
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/notifications/storages.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ def _message_queryset(self, include_read=False):
# and replaced PERSISTENT_MESSAGE_LEVELS by NON_PERSISTENT_MESSAGE_LEVELS

def _store(self, messages, response, *args, **kwargs):
# There are alredy saved.
# There are already saved.
return [
message for message in messages
if message.level not in NON_PERSISTENT_MESSAGE_LEVELS
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/notifications/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,6 @@ def message_user(self, message, level=messages.INFO, extra_tags='',
Send message through messages framework
"""
# TODO generalize this or check if implementation in ModelAdmin is
# useable here
# usable here
messages.add_message(self.request, level, message, extra_tags=extra_tags,
fail_silently=fail_silently)
2 changes: 1 addition & 1 deletion readthedocs/restapi/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ def sync_versions(project, versions, type): # pylint: disable=redefined-builtin


def set_or_create_version(project, slug, version_id, verbose_name, type_):
"""Search or create a version and set its machine atribute to false."""
"""Search or create a version and set its machine attribute to false."""
version = (
project.versions
.filter(slug=slug)
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/restapi/views/task_views.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def get_status_data(task_name, state, data, error=None):
'started': state in STARTED_STATES,
'finished': state in FINISHED_STATES,
# When an exception is raised inside the task, we keep this as SUCCESS
# and add the exception messsage into the 'error' key
# and add the exception message into the 'error' key
'success': state in SUCCESS_STATES and error is None,
}
if error is not None:
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/rtd_tests/tests/test_celery.py
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ def test_public_task_exception(self):
"""
Test when a PublicTask rises an Exception.

The exception should be catched and added to the ``info`` attribute of
The exception should be caught and added to the ``info`` attribute of
the result. Besides, the task should be SUCCESS.
"""
from readthedocs.core.utils.tasks import PublicTask
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/rtd_tests/tests/test_project.py
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ def test_user_can_change_project_with_same_lang(self):
self.assertEqual(project_a.language, 'en')
self.assertEqual(project_b.language, 'es')
data = model_to_dict(project_a)
# Same languge
# Same language
data['language'] = 'en'
resp = self.client.post(
reverse(
Expand Down
4 changes: 2 additions & 2 deletions readthedocs/rtd_tests/tests/test_project_symlinks.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class TempSiteRootTestCase(TestCase):
"""
Override SITE_ROOT and patch necessary pieces to inspect symlink structure.

This uses some patches and overidden settings to build out symlinking in a
This uses some patches and overridden settings to build out symlinking in a
temporary path. Each test is therefore isolated, and cleanup will remove
these paths after the test case wraps up.
"""
Expand Down Expand Up @@ -454,7 +454,7 @@ def test_subproject_alias_with_spaces(self):
self.assertFilesystem(filesystem)

def test_remove_subprojects(self):
"""Nonexistant subprojects are unlinked"""
"""Nonexistent subprojects are unlinked"""
self.project.add_subproject(self.subproject)
self.symlink.symlink_subprojects()
filesystem = {
Expand Down
4 changes: 2 additions & 2 deletions readthedocs/vcs_support/backends/git.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def are_submodules_available(self):

Temporarily, we support skipping these steps as submodule step can
fail if using private submodules. This will eventually be
configureable with our YAML config.
configurable with our YAML config.
"""
# TODO remove with https://github.com/rtfd/readthedocs-build/issues/30
from readthedocs.projects.models import Feature
Expand Down Expand Up @@ -108,7 +108,7 @@ def clone(self):
.. note::

Temporarily, we support skipping submodule recursive clone via a
feature flag. This will eventually be configureable with our YAML
feature flag. This will eventually be configurable with our YAML
config.
"""
# TODO remove with https://github.com/rtfd/readthedocs-build/issues/30
Expand Down