Skip to content

Commit

Permalink
docs: fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
joao-vitor-souza authored and nidhaloff committed Oct 29, 2022
1 parent 137c4b5 commit 16bac78
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
26 changes: 13 additions & 13 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ I needed to translate a text using python. It was hard to find a simple way to d
There are other libraries that can be used for this task, but most of them
are **buggy, not free, limited, not supported anymore or complex to use.**

Therefore, I decided to build this simple tool. It is 100% free, unlimited, easy to use and provide
Therefore, I decided to build this simple tool. It is 100% free, unlimited, easy to use and provides
support for all languages.

Basically, my goal was to integrate support for multiple famous translators
Expand All @@ -86,8 +86,8 @@ Why you should use it
======================

- It's the only python tool that integrates many translators
- multi language support
- supports batch translation
- Multi language support
- Supports batch translation
- High level of abstraction
- Automatic language detection
- Easy to use and extend
Expand Down Expand Up @@ -258,7 +258,7 @@ Google Translate
- You can also reuse the Translator class and change/update its properties.

(Notice that this is important for performance too since instantiating new objects is expensive)
(Notice that this is important for performance too, since instantiating new objects is expensive)


.. code-block:: python
Expand Down Expand Up @@ -410,7 +410,7 @@ Linguee Translator
# pass language by their abbreviation
translated_word = LingueeTranslator(source='en', target='fr').translate(word)
- Return all synonyms or words that matches
- Return all synonyms or words that match

.. code-block:: python
Expand Down Expand Up @@ -444,7 +444,7 @@ PONS Translator
# pass language by their abbreviation
translated_word = PonsTranslator(source='en', target='fr').translate(word)
- Return all synonyms or words that matches
- Return all synonyms or words that match

.. code-block:: python
Expand All @@ -462,8 +462,8 @@ Yandex Translator

.. note::

You need to require an **private api key** if you want to use the yandex translator.
visit the official website for more information about how to get one
You need to require a **private api key** if you want to use the yandex translator.
Visit the official website for more information about how to get one

- Language detection

Expand Down Expand Up @@ -503,7 +503,7 @@ Microsoft Translator
.. note::

You need to require an **api key** if you want to use the microsoft translator.
visit the official website for more information about how to get one.
Visit the official website for more information about how to get one.
Microsoft offers a free tier 0 subscription (2 million characters per month).

- Required and optional attributes
Expand Down Expand Up @@ -549,7 +549,7 @@ Papago Translator
.. note::

You need to require a **client id** and **client secret key** if you want to use the papago translator.
visit the official website for more information about how to get one.
Visit the official website for more information about how to get one.

.. code-block:: python
Expand Down Expand Up @@ -600,8 +600,8 @@ Libre Translator
Proxy usage
-------------

deep-translator provide out of the box usage of proxies. Just define your proxies config as a dictionary
and pass it to the corresponding translator. Below is an example using the GoogleTranslator but this feature
deep-translator provides out of the box usage of proxies. Just define your proxies config as a dictionary
and pass it to the corresponding translator. Below is an example using the GoogleTranslator, but this feature
can be used with all supported translators.

.. code-block:: python
Expand Down Expand Up @@ -768,5 +768,5 @@ Here are some screenshots:
Website & Desktop app
===========================

Currently, there are propositions for a website and/or dekstop app based on deep-translator.
Currently, there are propositions for a website and/or desktop app based on deep-translator.
You can follow the issue here: https://github.com/nidhaloff/deep-translator/issues/144
2 changes: 1 addition & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include any relevant tests (located under :file:`.deep_translator/tests`)
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. Pull requests are automatically tested on GitHub for compatability with Python version 3.7, 3.8, and 3.9. Please review your test results and ensure your request passes all tests.
3. Pull requests are automatically tested on GitHub for compatibility with Python version 3.7, 3.8, and 3.9. Please review your test results and ensure your request passes all tests.

Tips
----
Expand Down
10 changes: 5 additions & 5 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ Linguee Translator
# pass language by their abbreviation
translated_word = LingueeTranslator(source='en', target='fr').translate(word)
- Return all synonyms or words that matches
- Return all synonyms or words that match

.. code-block:: python
Expand Down Expand Up @@ -248,7 +248,7 @@ PONS Translator
# pass language by their abbreviation
translated_word = PonsTranslator(source='en', target='fr').translate(word)
- Return all synonyms or words that matches
- Return all synonyms or words that match

.. code-block:: python
Expand All @@ -266,8 +266,8 @@ Yandex Translator

.. note::

You need to require an **private api key** if you want to use the yandex translator.
visit the official website for more information about how to get one
You need to require n **private api key** if you want to use the yandex translator.
Visit the official website for more information about how to get one

- Language detection

Expand Down Expand Up @@ -345,7 +345,7 @@ For a quick access, you can use the deep_translator from terminal. For this to w
the right arguments, which are the translator you want to use, source language, target language and the text
you want to translate.

For example, provide "google" as an argument to use the google translator. Alternatively you can use
For example, provide "google" as an argument to use the google translator. Alternatively, you can use
the other supported translators. Just read the documentation to have an overview about the supported
translators in this library.

Expand Down

0 comments on commit 16bac78

Please sign in to comment.