Skip to content

Commit 67c604e

Browse files
committed
🔧 Add vale
* Fix language style
1 parent e966b69 commit 67c604e

File tree

10 files changed

+54
-41
lines changed

10 files changed

+54
-41
lines changed

.vale.ini

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
StylesPath = styles
2+
MinAlertLevel = suggestion
3+
4+
Packages = /Users/veit/cusy/prj/cusy-vale
5+
# https://github.com/cusyio/cusy-vale/archive/refs/tags/v0.1.0.zip
6+
7+
[*.{md,rst}]
8+
TokenIgnores = (:linenos:)
9+
BasedOnStyles = cusy-de

README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,8 @@ erstellen und darin eure Änderungen vorzunehmen. Gerne dürft ihr auch einen
143143
*Pull Request* stellen. Sofern die darin enthaltenen Änderungen klein und
144144
atomar sind, schaue ich mir eure Vorschläge gerne an.
145145

146-
Da eine englischsprachige Übersetzung gepflegt wird, beachtet bitte folgende Richtlinien:
146+
Da eine englischsprachige Übersetzung gepflegt wird, beachtet folgende
147+
Richtlinien:
147148

148149
* Commit messages auf Englisch
149150
* Commit messages mit einem `Gitmoji <https://gitmoji.dev/>`__ am Anfang

docs/data-processing/apis/grpc/example.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ Reihe von Name-Wert-Paaren enthält, die *fields* genannt werden.
2626
:lines: 1-7
2727

2828
.. warning::
29-
Beachtet bitte, dass ihr üblicherweise **nicht** einfach ``uint32`` für
30-
User- oder Group-IDs verwenden solltet, da diese viel zu einfach zu erraten
31-
wären. Hierfür könnt ihr :abbr:`z.B. (zum Beispiel)` eine
32-
:rfc:`4122`-konforme Implementierung verwenden. Eine entsprechende
33-
Protobuf-Konfiguration findet ihr in :download:`rfc4122.proto`.
29+
Beachtet, dass ihr üblicherweise **nicht** einfach ``uint32`` für User- oder
30+
Group-IDs verwenden solltet, da diese viel zu einfach zu erraten wären.
31+
Hierfür könnt ihr :abbr:`z.B. (zum Beispiel)` eine :rfc:`4122`-konforme
32+
Implementierung verwenden. Eine entsprechende Protobuf-Konfiguration findet
33+
ihr in :download:`rfc4122.proto`.
3434

3535
Nachdem ihr eure Datenstruktur definiert habt, könnt ihr das
3636
Protocol-Buffer-Compiler-Protokoll ``protoc`` verwenden, um Deskriptoren in

docs/data-processing/postgresql/fdw.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ entwickelt worden.
1313
Im Folgenden nur eine kleine Auswahl der bekanntesten FDW:
1414

1515
.. note::
16-
Beachtet bitte, dass die meisten dieser Wrapper nicht offiziell von der
17-
PostgreSQL Global Development Group (PGDG) unterstützt werden.
16+
Beachtet, dass die meisten dieser Wrapper nicht offiziell von der PostgreSQL
17+
Global Development Group (PGDG) unterstützt werden.
1818

1919
Generische SQL-Wrapper
2020
----------------------

docs/data-processing/serialisation-formats/json/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ JSON
1818
| | | JavaScript: ``NaN`` und ``Infinity`` werden zu |
1919
| | | ``null``. |
2020
| | | |
21-
| | | Bitte beachtet auch, dass die JSON keine Kommentare |
21+
| | | Beachtet auch, dass die JSON keine Kommentare |
2222
| | | unterstützt und ihr gegebenenfalls darum herumarbeiten|
2323
| | | müsst, z.B. mit einem ``__comment__`` |
2424
| | | Schlüssel/Wert-Paar. |

docs/productive/dvc/index.rst

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ Abhängigkeiten angeben.
5454
Installation
5555
------------
5656

57-
DVC lässt sich mit Pipenv installieren. Beachtet dabei jedoch bitte, dass ihr
58-
hierbei die Extras explizit angeben müsst. Dies können ``[ssh]``, ``[s3]``,
59-
``[gs]``, ``[azure]``, und ``[oss]`` oder ``[all]`` sein. Für ``ssh`` sieht das
60-
Kommando dann so aus:
57+
DVC lässt sich mit Pipenv installieren. Beachtet dabei jedoch, dass ihr hierbei
58+
die Extras explizit angeben müsst. Dies können ``[ssh]``, ``[s3]``, ``[gs]``,
59+
``[azure]``, und ``[oss]`` oder ``[all]`` sein. Für ``ssh`` sieht das Kommando
60+
dann so aus:
6161

6262
.. code-block:: console
6363
@@ -80,24 +80,23 @@ Alternativ kann DVC auch über andere Paketmanager installiert werden:
8080
$ brew install iterative/homebrew-dvc/dvc
8181
8282
.. note::
83-
84-
Bitte beachtet, dass das folgende Beispiel mit einer aktuellen DVC-Version
85-
erstellt wurde (1.0.0a9), die :abbr:`z.T. (zum Teil)` eine andere Syntax als
86-
frühere Versionen verwendet. Dies könnt ihr aktuell (8. Juni 2020) nur mit
87-
pip installieren:
83+
Beachtet, dass das folgende Beispiel mit einer aktuellen DVC-Version erstellt
84+
wurde (1.0.0a9), die :abbr:`z.T. (zum Teil)` eine andere Syntax als frühere
85+
Versionen verwendet. Dies könnt ihr aktuell (8. Juni 2020) nur mit pip
86+
installieren:
8887

8988
.. code-block:: console
9089
9190
$ pipenv install dvc[all]==1.0.0a9
9291
9392
.. toctree::
94-
:hidden:
95-
96-
init
97-
pipeline
98-
params
99-
metrics
100-
dag
101-
reproduce
102-
integration
103-
fds
93+
:hidden:
94+
95+
init
96+
pipeline
97+
params
98+
metrics
99+
dag
100+
reproduce
101+
integration
102+
fds

docs/productive/git/advanced/git-big-picture.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -109,19 +109,19 @@ erstellt den folgenden Abschnitt in eurer ``~/.gitconfig``-Datei:
109109
viewer = firefox
110110
111111
.. note::
112-
Bitte beachtet jedoch, dass ihr dann keine anderen Optionen mehr auswählen
113-
könnt. So könnt ihr nun den Graph nicht mehr als Graphviz ausgeben lassen:
112+
Beachtet, dass ihr dann keine anderen Optionen mehr auswählen könnt. So könnt
113+
ihr nun den Graph nicht mehr als Graphviz ausgeben lassen:
114114

115-
.. code-block:: console
115+
.. code-block:: console
116116
117-
$ git-big-picture -g
118-
fatal: Options '-g | --graphviz' and '-p | --processed' are incompatible with other output options.
117+
$ git-big-picture -g
118+
fatal: Options '-g | --graphviz' and '-p | --processed' are incompatible with other output options.
119119
120-
In diesem Fall müsst ihr dann die ``-V`` oder ``--no-viewer``-Option wählen:
120+
In diesem Fall müsst ihr dann die ``-V`` oder ``--no-viewer``-Option wählen:
121121

122-
.. code-block:: console
122+
.. code-block:: console
123123
124-
$ git-big-picture -g -V
125-
digraph {
126-
"c509669a01b156900eed9f1c9f927b6d2f7bb95b"[label="origin/pyup-scheduled-update-2020-11-16", color="/pastel13/2", style=filled];
127-
124+
$ git-big-picture -g -V
125+
digraph {
126+
"c509669a01b156900eed9f1c9f927b6d2f7bb95b"[label="origin/pyup-scheduled-update-2020-11-16", color="/pastel13/2", style=filled];
127+

docs/productive/licensing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ soll, ist häufig die Zustimmung aller Personen erforderlich, die Urheberschaft
1313
beanspruchen können.
1414

1515
.. note::
16-
Dies stellt keine Rechtsberatung dar. Wendet euch im Zweifelsfall bitte an
17-
eine Rechtsvertretung oder die Rechtsabteilung eures Unternehmens.
16+
Dies stellt keine Rechtsberatung dar. Wendet euch im Zweifelsfall an eine
17+
Rechtsvertretung oder die Rechtsabteilung eures Unternehmens.
1818

1919
.. seealso::
2020
* `The Whys and Hows of Licensing Scientific Code

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ dev = [
3636
"Python4DataScience[docs]",
3737
"pre-commit",
3838
"codespell",
39+
"vale",
3940
]
4041

4142
[project.urls]

styles/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# ignore everything except .gitignore
2+
*
3+
!.gitignore

0 commit comments

Comments
 (0)