Skip to content

Commit

Permalink
🔧 Update vale
Browse files Browse the repository at this point in the history
* Fix polite style
  • Loading branch information
veit committed Oct 8, 2024
1 parent bca11aa commit f7f0335
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@ test.png

# pip install -e .
cusy_design_system.egg-info/

#vale
styles/*
7 changes: 5 additions & 2 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
StylesPath = ./docs/.vale
StylesPath = styles
MinAlertLevel = suggestion

Packages = https://github.com/cusyio/cusy-vale/archive/refs/tags/v0.1.0.zip

[*.{md,rst}]
BasedOnStyles = cusy
TokenIgnores = (:linenos:)
BasedOnStyles = cusy-de
9 changes: 5 additions & 4 deletions docs/viz/diagram-anatomy/legends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,11 @@ und die Legende wird auf ihren Standardzustand zurückgesetzt.
Versteckte Legenden
~~~~~~~~~~~~~~~~~~~

Bitte beachtet, dass sich das Ausblenden von Legenden in Datenvisualisierungen
nur sehr selten empfiehlt, es sei denn, es wird nur eine Datenkategorie
angezeigt. Dieses Design ist für kleine mobile Displays gedacht, bei denen
Legenden den Blick auf die Datenvisualisierung versperren würde.
.. note::
Das Ausblenden von Legenden in Datenvisualisierungen empfiehlt sich nur sehr
selten, es sei denn, es wird nur eine Datenkategorie angezeigt. Dieses Design
ist für kleine mobile Displays gedacht, bei denen Legenden den Blick auf die
Datenvisualisierung versperren würde.

.. figure:: legends-hidden-1.png
:alt: Auf dem Handy versteckte Legenden
Expand Down
13 changes: 11 additions & 2 deletions docs/writing/voice-tone.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ euer Text vielleicht in andere Sprachen übersetzt wird.
Was ihr vermeiden solltet
-------------------------

.. vale off
* Buzzwords oder Fachjargon
* niedlich oder albern sein wollen
* aktuelle popkulturelle Anspielungen
Expand All @@ -39,8 +41,11 @@ Was ihr vermeiden solltet
* Vereinnahmende Formulierungen wie *Lasst uns das machen*.
* Die Verwendung von Ausdrücken wie *einfach*, *es ist so einfach* oder
*schnell*
* Internet-Slang oder -Abkürzungen wie :abbr:`tl;dr (Too long; didn’t read)` oder
:abbr:`ymmv (englisch: Je nach dem, wie weit ihr geht, kann das variieren)`
* Internet-Slang oder -Abkürzungen wie :abbr:`tl;dr (Too long; didn’t read)`
oder :abbr:`ymmv (englisch: Je nach dem, wie weit ihr geht, kann das
variieren)`

.. vale on
Was ihr berücksichtigen solltet
-------------------------------
Expand All @@ -66,6 +71,8 @@ Was ihr berücksichtigen solltet
Seid höfflich
-------------

.. vale off
Es ist schön, höflich zu sein, aber die Verwendung von *bitte* in einer
Anweisung ist übertrieben.

Expand All @@ -74,6 +81,8 @@ Anweisung ist übertrieben.
* ✅ Weitere Informationen finden Sie unter …
* ❌ Für weitere Informationen klickt bitte auf …

.. vale on
Beispiele
---------

Expand Down
4 changes: 4 additions & 0 deletions docs/writing/writing-style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ Einfaches Schreiben
Verwendet einfache Wörter und Sätze
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. vale off
* Verwendet den einfachsten Begriff, der für das Publikum geeignet ist.
Verwendet beispielsweise *groß* statt *voluminös* und *klein* anstelle von
*Diminutiv*.
Expand All @@ -64,6 +66,8 @@ Verwendet einfache Wörter und Sätze
da sie in manchen kulturellen Kontexten unangemessen oder beleidigend sein
könnten.

.. vale on
.. note::
Erstellt eine Liste mit Wörtern für euer Thema, die sowohl bevorzugte wie auch nicht zu
verwendende Wörter enthält. Dieses einfache Werkzeug kann im Laufe der Zeit zur
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ docs = [
dev = [
"cusy-design-system[docs]",
"pre-commit",
"vale",
]

[project.urls]
Expand Down
3 changes: 3 additions & 0 deletions styles/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ignore everything except .gitignore
*
!.gitignore

0 comments on commit f7f0335

Please sign in to comment.