Fix codespell typos in doc

ltelab · Oct 25, 2023 · 9ed083d · 9ed083d
1 parent d933add
commit 9ed083d
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -27,5 +27,5 @@ repos:
     rev: v2.2.6
     hooks:
     - id: codespell
-      types_or: [python, markdown]
+      types_or: [python, markdown, rst]
       additional_dependencies: [tomli]
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -8,7 +8,7 @@ You can contribute in many ways :
 -  Join the
    `discussion <https://github.com/ltelab/disdrodb/discussions>`__
 - Report `issues <#issue-reporting-guidelines>`__
-- Help us developping new readers
+- Help us developing new readers
 - Any others code improvements are welcome !
 
 
@@ -76,7 +76,7 @@ to identify simple code quality issues. When an issue is identified
 commit and prints the error. Currently, DISDRODB only tests that the
 code to be committed complies with black's format style and the ruff linter.
 
-In case that the commit is aborted, you only need to run black agains you code.
+In case that the commit is aborted, you only need to run the precommit hook again.
 This can be done by running   ``black .``  or   ``ruff check .``
 
 .. note::
@@ -215,9 +215,9 @@ Here is an example of a docstring:
        Parameters
        ----------
        gamma_1 : float
-         Lag-1 temporal autocorrelation coeffient.
+         Lag-1 temporal autocorrelation coefficient.
        gamma_2 : float
-         Lag-2 temporal autocorrelation coeffient.
+         Lag-2 temporal autocorrelation coefficient.
 
        Returns
        -------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -27,7 +27,7 @@ national agencies (e.g. the NASA Precipitation Measurement Mission - PMM - Scien
 and university research groups.
 However, only a small fraction of those data is easily accessible.
 Data are stored in disparate formats with poor documentation, making them
-difficult to share, analyse, compare and re-use.
+difficult to share, analyse, compare and reuse.
 
 Additionally, very limited software is currently publicly available for DSD processing.
 

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -111,7 +111,7 @@ This can be done by running ``black .`` and ``ruff check .`` or alternatively wi
 The latter is recommended since it indicates if the commit contained any formatting errors (that are automatically corrected).
 
 .. note::
-	To maintain consitency, we use Black version `22.8.0` (as defined into `.pre-commit-config.yaml`). Make sure to stick to version.
+	To maintain consistency, we use Black version `22.8.0` (as defined into `.pre-commit-config.yaml`). Make sure to stick to version.
 
 
 

diff --git a/docs/source/maintainers_guidelines.rst b/docs/source/maintainers_guidelines.rst
@@ -108,7 +108,7 @@ One  `GitHub Action <https://github.com/ltelab/disdrodb/actions>`_ is defined to
 
 .. image:: /static/package_pipepline.png
 
-The `PyPi <https://pypi.org/>`__ project is shared beween the core contributors.
+The `PyPi <https://pypi.org/>`__ project is shared between the core contributors.
 
 
 
@@ -128,7 +128,7 @@ The review process is the following:
 
 
 
-Continuous intergration (CI) testing tools
+Continuous integration (CI) testing tools
 ===========================================
 
 Currently, on each Pull Request, GitHub Actions are configured as follow:

diff --git a/docs/source/readers.rst b/docs/source/readers.rst
@@ -468,7 +468,7 @@ These notebooks will guide you through the definition of the 4 relevant DISDRODB
 For more information on the possible key-value arguments, read the `pandas <https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html>`_
 documentation.
 
-* The ``column_names`` list defines the column names of the readed raw text file.
+* The ``column_names`` list defines the column names of the read raw text file.
 
 * The ``df_sanitizer_fun()`` function that defines the processing to apply on the read dataframe in order for the dataframe to match the DISDRODB   standards.