🔧 Add vale

* Fix spelling mistakes
cusyio · Sep 23, 2024 · 96b9a4a · 96b9a4a
1 parent 8aff5c9
commit 96b9a4a
Show file tree

Hide file tree

Showing 13 changed files with 28 additions and 23 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,3 +30,6 @@ panel-examples
 deploy-panel.html
 test.png
 pyviz.pkl
+
+# vale
+styles/*
diff --git a/.vale.ini b/.vale.ini
@@ -2,12 +2,11 @@
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
-StylesPath = ./styles
+StylesPath = styles
 MinAlertLevel = suggestion
 
-[*.{md,rst}]
-BasedOnStyles = cusy
+Packages = https://github.com/cusyio/cusy-vale/archive/refs/tags/v0.1.0.zip
 
-vale.Redundancy = YES
-vale.Repetition = YES
-vale.GenderBias = YES
+[*.{md,rst}]
+TokenIgnores = (:linenos:)
+BasedOnStyles = cusy-en
diff --git a/docs/data-processing/nosql/document-oriented-db.rst b/docs/data-processing/nosql/document-oriented-db.rst
@@ -45,8 +45,8 @@ OrientDB and ArangoDB.
 |                        |                                |* distributed systems:          |                                |                                |                                |
 |                        |                                |  :term:`BASE`                  |                                |                                |                                |
 +------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+
-| **Replication,         | Master-Slave replikation,      | Master-master replication      | Multi-master replication       | Multi-Master-Replikation,      | Master-slave replication,      |
-| skaling**              | Auto-Sharding                  |                                |                                | Sharding                       | sharding                       |
+| **Replication,         | Master-Slave replication,      | Master-master replication      | Multi-master replication       | Multi-Master-Replication,      | Master-slave replication,      |
+| scaling**              | Auto-Sharding                  |                                |                                | Sharding                       | sharding                       |
 +------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+--------------------------------+
 | **Remarks**            | `BSON` with a maximum          |                                |                                |                                |                                |
 |                        | document size of 16 MB.        |                                |                                |                                |                                |

diff --git a/docs/performance/index.rst b/docs/performance/index.rst
@@ -199,7 +199,7 @@ Special data structures
 Select compiler
 ---------------
 
-Faster Cpython
+Faster CPython
 ~~~~~~~~~~~~~~
 
 At PyCon US in May 2021, Guido van Rossum presented `Faster CPython

diff --git a/docs/productive/cite/software/doi.rst b/docs/productive/cite/software/doi.rst
@@ -17,7 +17,7 @@ example of the Jupyter tutorial:
    Object Identifier)` for your upload. Leave the form open to upload your
    software later.
 
-#. Create or modify the :doc:`codemeta`- und :doc:`cff` files in your software
+#. Create or modify the :doc:`codemeta`- and :doc:`cff` files in your software
    directory.
 
 #. Include the badge in the :file:`README` file of your software:
@@ -49,4 +49,4 @@ example of the Jupyter tutorial:
 #. Create a new release:
 
    .. figure:: github-release.png
-      :alt: Github releases
+      :alt: GitHub releases
diff --git a/docs/productive/cite/software/hermes.rst b/docs/productive/cite/software/hermes.rst
@@ -44,18 +44,18 @@ repositories.
    token
    <https://sandbox.zenodo.org/account/settings/applications/tokens/new/>`_ in
    your user profile with the name :samp:`HERMES workflow` and the scopes
-   :guilabel:`deposit:actions` und :guilabel:`deposit:write`:
+   :guilabel:`deposit:actions` and :guilabel:`deposit:write`:
 
    .. image:: zenodo-personal-access-token.png
-      :alt: Zenodo: Neues persönliches Zugangstoken
+      :alt: Zenodo: New personal access token
 
 #. Copy the newly created token to a new `GitHub secret
    <https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository>`_
    named :samp:`ZENODO_SANDBOX` in your repository: `Settings --> Secrets and
    Variables --> Actions --> New repository secret`:
 
    .. image:: github-new-action-secret.png
-      :alt: GitHub: Neues Action-Secret
+      :alt: GitHub: New action secret
 
 #. Configure the GitHub action
 

diff --git a/docs/productive/cite/software/index.rst b/docs/productive/cite/software/index.rst
@@ -93,7 +93,6 @@ Tools
 
 :doc:`git2prov`
     generates PROV data from the information in a Git repository.
-    generiert PROV-Daten aus den Informationen eines Git-Repository.
 :doc:`hermes`
     simplifies the publication of research software by continuously retrieving
     existing metadata in :doc:`cff`, :doc:`codemeta` and :doc:`Git

diff --git a/docs/productive/dvc/metrics.rst b/docs/productive/dvc/metrics.rst
@@ -11,7 +11,7 @@ experiments.
 
 `evaluate.py
 <https://github.com/veit/dvc-example/blob/main/src/evaluate.py>`_
-calculates the AUC (**A** rea **U** nder the **C** urve). It uses the test data
+calculates the :abbr:`AUC (Area Under the Curve)`. It uses the test data
 set, reads the features from the file ``features/test.pkl`` and creates the
 metrics file ``auc.metric``. It can be identified as a DVC metric with the
 ``-M`` option of `dvc run <https://dvc.org/doc/command-reference/stage/add>`_,

diff --git a/docs/productive/git/best-practices.rst b/docs/productive/git/best-practices.rst
@@ -243,7 +243,7 @@ can activate it globally with:
 
    $ git config --global commit.cleanup scissors
 
-Git then starts each new commit message with the *Scissorsr* line:
+Git then starts each new commit message with the *Scissors* line:
 
 .. code-block:: ini
 
@@ -332,7 +332,7 @@ template, for example, in a stage called ``secrets-detection`` in your
 
 The template creates secret detection jobs in your CI/CD pipeline and searches
 the source code of your project for secrets. The results are saved as a `Secret
-Detection Report Artefakt
+Detection Report Artifact
 <https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportssecret_detection>`_
 that you can download and analyse later.
 

diff --git a/docs/productive/qa/pysa.rst b/docs/productive/qa/pysa.rst
@@ -54,7 +54,7 @@ Pyre can be called, for example with
 The  ``--save-results-to`` option stores detailed results in
 ``./taint-output.json``.
 
-Pysa postprozessor
+Pysa postprocessor
 ------------------
 
 Installation

diff --git a/docs/productive/security.rst b/docs/productive/security.rst
@@ -74,11 +74,11 @@ tells you that you should investigate the situation more closely.
 You can also display the activities of a project with badges, for example:
 
 .. image:: https://img.shields.io/github/commit-activity/y/veit/python4datascience
-   :alt: Jährliche Commit-Aktivität
+   :alt: Annual commit activity
 .. image:: https://img.shields.io/github/commit-activity/m/veit/python4datascience
-   :alt: Monatliche Commit-Aktivität
+   :alt: Monthly commit activity
 .. image:: https://img.shields.io/github/commit-activity/w/veit/python4datascience
-   :alt: Wöchentliche Commit-Aktivität
+   :alt: Weekly commit activity
 
 Is there a safety concept for the project?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -175,7 +175,7 @@ Risk: Medium
 
 `Static code analysis <https://en.wikipedia.org/wiki/Static_program_analysis>`_
 tests the source code before the application is executed. This can prevent known
-bug classes from being accidentally introduced into the codebase.
+bug classes from being accidentally introduced into the code base.
 
 To check for vulnerabilities, you can use `bandit
 <https://github.com/PyCQA/bandit>`_, which you can also integrate into your

diff --git a/pyproject.toml b/pyproject.toml
@@ -32,6 +32,7 @@ dev = [
     "Python4DataScience[docs]",
     "pre-commit",
     "codespell",
+    "vale",
 ]
 
 [project.urls]

diff --git a/styles/.gitignore b/styles/.gitignore
@@ -0,0 +1,3 @@
+# ignore everything except .gitignore
+*
+!.gitignore