Skip to content

Commit

Permalink
Fix typos in documentation (asreview#1205)
Browse files Browse the repository at this point in the history
  • Loading branch information
pitmonticone authored Aug 28, 2022
1 parent c811cd2 commit cd79627
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 13 deletions.
4 changes: 2 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The source files are available in the [`docs`](/docs) folder of this repository.
use of [Sphinx](https://www.sphinx-doc.org/) to convert the source files and docstrings into HTML
or PDF files.

Install the dependcies for rendering the documenation with
Install the dependencies for rendering the documentation with

```
pip install -r docs/requirements.txt
Expand Down Expand Up @@ -129,7 +129,7 @@ You can deploy ASReview LAB right now in one click on any of these clouds provid
[<img src="https://deploy.cloud.run/button.svg" height="30px">](https://deploy.cloud.run)
[<img src="https://www.herokucdn.com/deploy/button.svg" height="30px">](https://heroku.com/deploy?template=https://github.com/asreview/asreview/tree/master)

❗❗❗ ASReview doens't have builtin authentication. You are responsible for the authentication and security of the server yourself.
❗❗❗ ASReview doesn't have builtin authentication. You are responsible for the authentication and security of the server yourself.


## Release instructions
Expand Down
2 changes: 1 addition & 1 deletion docs/source/data_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ default mapping can be found on the `rispy GitHub page <https://github.com/MrTan
When re-importing a partly labeled dataset in the the RIS file format, the
labels stored in the N1 field are used as prior knowledge. When a completely
labeled dataset is re-imported it can be used in the Exploration and
Simualtion mode.
Simulation mode.



Expand Down
2 changes: 1 addition & 1 deletion docs/source/data_labeled.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Partially labeled data
Useful for Oracle projects. Read more about :ref:`project_create:Project modes`.

Partially labeled datasets are datasets with a labeling decision for a subset
of the records in the dataset and no decission for another subset.
of the records in the dataset and no decision for another subset.

A partially labeled dataset can be obtained by exporting results from ASReview
LAB or other software. It can also be constructed given the format described
Expand Down
2 changes: 1 addition & 1 deletion docs/source/extensions_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ class method ``execute``.
It is strongly recommended to define the attributes ``description``,
``extension_name``, and ``version``.

The class method ``execute`` accepts a positional arugument (``argv`` in this
The class method ``execute`` accepts a positional argument (``argv`` in this
example). First create the functionality you would like to be able to use in
any directory. The argument ``argv`` are the command line arguments left after
removing asreview and the entry point.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/progress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ The file is ordered as follows:

1. All relevant records you have seen in the order they were shown during the screening process.
2. All records not seen during the screening and ordered from most to least relevant according to the last iteration of the model.
3. All non-relevant records are presented in the order these are shown during the screening proces.
3. All non-relevant records are presented in the order these are shown during the screening process.


To download your results follow these steps:
Expand Down
1 change: 0 additions & 1 deletion docs/source/simulation_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,3 @@ Simulations require :ref:`fully labeled datasets <data_labeled:fully labeled dat
<https://asreview.ai/blog/the-importance-of-abstracts/>`_). With clean data you
benefit most from what :doc:`active learning <about>`
has to offer.

8 changes: 4 additions & 4 deletions docs/source/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ First, check if Python is installed with the following command:
If this doesn't return 3.7 or higher, then Python isn't or not correctly
installed.

Most likely, the enviroment variables aren't configured correctly. Follow
Most likely, the environment variables aren't configured correctly. Follow
the step-by-step installation instruction on the ASReview website (`Windows <https://asreview.ai/download/>`__
and `MacOS <https://asreview.ai/download/>`__).

However, there is a simple way to deal with correct environment variables
by ading `python -m` in front of the command. For example:
by adding `python -m` in front of the command. For example:

.. code:: bash
Expand All @@ -45,7 +45,7 @@ Unknown command "asreview"

In some situations, the entry point "asreview" can not be found after installation.
First check whether the package is correctly installed. Do this with the command
`python -m asreview -h`. If this shows a decription of the program, use
`python -m asreview -h`. If this shows a decryption of the program, use
`python -m` in front of all your commands. For example:

.. code-block:: bash
Expand Down Expand Up @@ -82,7 +82,7 @@ However, the easiest way to remove these files is with:
asreview lab --clean-all-projects
This will safely remove temporay files, nothing will harm your review. To
This will safely remove temporary files, nothing will harm your review. To
clean a specific project, use

.. code:: bash
Expand Down
4 changes: 2 additions & 2 deletions versioneer.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@
`setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI
distributions (and upload multiple independently-installable tarballs).
* Source trees whose main purpose is to contain a C library, but which also
provide bindings to Python (and perhaps other langauges) in subdirectories.
provide bindings to Python (and perhaps other languages) in subdirectories.
Versioneer will look for `.git` in parent directories, and most operations
should get the right version string. However `pip` and `setuptools` have bugs
Expand Down Expand Up @@ -420,7 +420,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,

LONG_VERSION_PY['git'] = '''
# This file helps to compute a version number in source trees obtained from
# git-archive tarball (such as those provided by githubs download-from-tag
# git-archive tarball (such as those provided by github's download-from-tag
# feature). Distribution tarballs (built by setup.py sdist) and build
# directories (produced by setup.py build) will contain a much shorter file
# that just contains the computed version number.
Expand Down

0 comments on commit cd79627

Please sign in to comment.