From 48b314d8ab2501cc88ef78712612e2ebb94e1e07 Mon Sep 17 00:00:00 2001 From: Veit Schiele Date: Tue, 1 Oct 2024 13:42:01 +0200 Subject: [PATCH] :wrench: Add vale * Fix language style --- .vale.ini | 9 +++++ README.rst | 3 +- docs/data-processing/apis/grpc/example.rst | 10 ++--- docs/data-processing/postgresql/fdw.rst | 4 +- .../serialisation-formats/json/index.rst | 2 +- docs/productive/dvc/index.rst | 37 +++++++++---------- .../git/advanced/git-big-picture.rst | 22 +++++------ docs/productive/licensing.rst | 4 +- pyproject.toml | 1 + styles/.gitignore | 3 ++ 10 files changed, 54 insertions(+), 41 deletions(-) create mode 100644 .vale.ini create mode 100644 styles/.gitignore diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000..641b1721 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,9 @@ +StylesPath = styles +MinAlertLevel = suggestion + +Packages = /Users/veit/cusy/prj/cusy-vale +# https://github.com/cusyio/cusy-vale/archive/refs/tags/v0.1.0.zip + +[*.{md,rst}] +TokenIgnores = (:linenos:) +BasedOnStyles = cusy-de diff --git a/README.rst b/README.rst index 073114cc..94f29297 100644 --- a/README.rst +++ b/README.rst @@ -143,7 +143,8 @@ erstellen und darin eure Änderungen vorzunehmen. Gerne dürft ihr auch einen *Pull Request* stellen. Sofern die darin enthaltenen Änderungen klein und atomar sind, schaue ich mir eure Vorschläge gerne an. -Da eine englischsprachige Übersetzung gepflegt wird, beachtet bitte folgende Richtlinien: +Da eine englischsprachige Übersetzung gepflegt wird, beachtet folgende +Richtlinien: * Commit messages auf Englisch * Commit messages mit einem `Gitmoji `__ am Anfang diff --git a/docs/data-processing/apis/grpc/example.rst b/docs/data-processing/apis/grpc/example.rst index 82dc09f8..20a8d144 100644 --- a/docs/data-processing/apis/grpc/example.rst +++ b/docs/data-processing/apis/grpc/example.rst @@ -26,11 +26,11 @@ Reihe von Name-Wert-Paaren enthält, die *fields* genannt werden. :lines: 1-7 .. warning:: - Beachtet bitte, dass ihr üblicherweise **nicht** einfach ``uint32`` für - User- oder Group-IDs verwenden solltet, da diese viel zu einfach zu erraten - wären. Hierfür könnt ihr :abbr:`z.B. (zum Beispiel)` eine - :rfc:`4122`-konforme Implementierung verwenden. Eine entsprechende - Protobuf-Konfiguration findet ihr in :download:`rfc4122.proto`. + Beachtet, dass ihr üblicherweise **nicht** einfach ``uint32`` für User- oder + Group-IDs verwenden solltet, da diese viel zu einfach zu erraten wären. + Hierfür könnt ihr :abbr:`z.B. (zum Beispiel)` eine :rfc:`4122`-konforme + Implementierung verwenden. Eine entsprechende Protobuf-Konfiguration findet + ihr in :download:`rfc4122.proto`. Nachdem ihr eure Datenstruktur definiert habt, könnt ihr das Protocol-Buffer-Compiler-Protokoll ``protoc`` verwenden, um Deskriptoren in diff --git a/docs/data-processing/postgresql/fdw.rst b/docs/data-processing/postgresql/fdw.rst index 00e3eef0..83536d48 100644 --- a/docs/data-processing/postgresql/fdw.rst +++ b/docs/data-processing/postgresql/fdw.rst @@ -13,8 +13,8 @@ entwickelt worden. Im Folgenden nur eine kleine Auswahl der bekanntesten FDW: .. note:: - Beachtet bitte, dass die meisten dieser Wrapper nicht offiziell von der - PostgreSQL Global Development Group (PGDG) unterstützt werden. + Beachtet, dass die meisten dieser Wrapper nicht offiziell von der PostgreSQL + Global Development Group (PGDG) unterstützt werden. Generische SQL-Wrapper ---------------------- diff --git a/docs/data-processing/serialisation-formats/json/index.rst b/docs/data-processing/serialisation-formats/json/index.rst index 50d3aa3c..8450e42f 100644 --- a/docs/data-processing/serialisation-formats/json/index.rst +++ b/docs/data-processing/serialisation-formats/json/index.rst @@ -18,7 +18,7 @@ JSON | | | JavaScript: ``NaN`` und ``Infinity`` werden zu | | | | ``null``. | | | | | -| | | Bitte beachtet auch, dass die JSON keine Kommentare | +| | | Beachtet auch, dass die JSON keine Kommentare | | | | unterstützt und ihr gegebenenfalls darum herumarbeiten| | | | müsst, z.B. mit einem ``__comment__`` | | | | Schlüssel/Wert-Paar. | diff --git a/docs/productive/dvc/index.rst b/docs/productive/dvc/index.rst index 4ee3923a..e13af86d 100644 --- a/docs/productive/dvc/index.rst +++ b/docs/productive/dvc/index.rst @@ -54,10 +54,10 @@ Abhängigkeiten angeben. Installation ------------ -DVC lässt sich mit Pipenv installieren. Beachtet dabei jedoch bitte, dass ihr -hierbei die Extras explizit angeben müsst. Dies können ``[ssh]``, ``[s3]``, -``[gs]``, ``[azure]``, und ``[oss]`` oder ``[all]`` sein. Für ``ssh`` sieht das -Kommando dann so aus: +DVC lässt sich mit Pipenv installieren. Beachtet dabei jedoch, dass ihr hierbei +die Extras explizit angeben müsst. Dies können ``[ssh]``, ``[s3]``, ``[gs]``, +``[azure]``, und ``[oss]`` oder ``[all]`` sein. Für ``ssh`` sieht das Kommando +dann so aus: .. code-block:: console @@ -80,24 +80,23 @@ Alternativ kann DVC auch über andere Paketmanager installiert werden: $ brew install iterative/homebrew-dvc/dvc .. note:: - - Bitte beachtet, dass das folgende Beispiel mit einer aktuellen DVC-Version - erstellt wurde (1.0.0a9), die :abbr:`z.T. (zum Teil)` eine andere Syntax als - frühere Versionen verwendet. Dies könnt ihr aktuell (8. Juni 2020) nur mit - pip installieren: + Beachtet, dass das folgende Beispiel mit einer aktuellen DVC-Version erstellt + wurde (1.0.0a9), die :abbr:`z.T. (zum Teil)` eine andere Syntax als frühere + Versionen verwendet. Dies könnt ihr aktuell (8. Juni 2020) nur mit pip + installieren: .. code-block:: console $ pipenv install dvc[all]==1.0.0a9 .. toctree:: - :hidden: - - init - pipeline - params - metrics - dag - reproduce - integration - fds + :hidden: + + init + pipeline + params + metrics + dag + reproduce + integration + fds diff --git a/docs/productive/git/advanced/git-big-picture.rst b/docs/productive/git/advanced/git-big-picture.rst index 0058765d..3eab82b1 100644 --- a/docs/productive/git/advanced/git-big-picture.rst +++ b/docs/productive/git/advanced/git-big-picture.rst @@ -109,19 +109,19 @@ erstellt den folgenden Abschnitt in eurer ``~/.gitconfig``-Datei: viewer = firefox .. note:: - Bitte beachtet jedoch, dass ihr dann keine anderen Optionen mehr auswählen - könnt. So könnt ihr nun den Graph nicht mehr als Graphviz ausgeben lassen: + Beachtet, dass ihr dann keine anderen Optionen mehr auswählen könnt. So könnt + ihr nun den Graph nicht mehr als Graphviz ausgeben lassen: - .. code-block:: console + .. code-block:: console - $ git-big-picture -g - fatal: Options '-g | --graphviz' and '-p | --processed' are incompatible with other output options. + $ git-big-picture -g + fatal: Options '-g | --graphviz' and '-p | --processed' are incompatible with other output options. - In diesem Fall müsst ihr dann die ``-V`` oder ``--no-viewer``-Option wählen: + In diesem Fall müsst ihr dann die ``-V`` oder ``--no-viewer``-Option wählen: - .. code-block:: console + .. code-block:: console - $ git-big-picture -g -V - digraph { - "c509669a01b156900eed9f1c9f927b6d2f7bb95b"[label="origin/pyup-scheduled-update-2020-11-16", color="/pastel13/2", style=filled]; - … + $ git-big-picture -g -V + digraph { + "c509669a01b156900eed9f1c9f927b6d2f7bb95b"[label="origin/pyup-scheduled-update-2020-11-16", color="/pastel13/2", style=filled]; + … diff --git a/docs/productive/licensing.rst b/docs/productive/licensing.rst index 439e2888..2eaf7a29 100644 --- a/docs/productive/licensing.rst +++ b/docs/productive/licensing.rst @@ -13,8 +13,8 @@ soll, ist häufig die Zustimmung aller Personen erforderlich, die Urheberschaft beanspruchen können. .. note:: - Dies stellt keine Rechtsberatung dar. Wendet euch im Zweifelsfall bitte an - eine Rechtsvertretung oder die Rechtsabteilung eures Unternehmens. + Dies stellt keine Rechtsberatung dar. Wendet euch im Zweifelsfall an eine + Rechtsvertretung oder die Rechtsabteilung eures Unternehmens. .. seealso:: * `The Whys and Hows of Licensing Scientific Code diff --git a/pyproject.toml b/pyproject.toml index e5bbaa29..dbe4aa9b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,6 +36,7 @@ dev = [ "Python4DataScience[docs]", "pre-commit", "codespell", + "vale", ] [project.urls] diff --git a/styles/.gitignore b/styles/.gitignore new file mode 100644 index 00000000..888cacec --- /dev/null +++ b/styles/.gitignore @@ -0,0 +1,3 @@ +# ignore everything except .gitignore +* +!.gitignore