changeset 24:449f7c8ede19

FIX: Add docu for break_on_keynames_problems
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 08 Jul 2023 11:53:11 +0200
parents 413b344be2d1
children fd2a40c3d87b
files docs/schema.txt
diffstat 1 files changed, 11 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/docs/schema.txt	Sat Jul 08 10:15:50 2023 +0200
+++ b/docs/schema.txt	Sat Jul 08 11:53:11 2023 +0200
@@ -36,6 +36,15 @@
   Bei Treffer wird dieser Key komplett ignoriert. Das ist also eine globale
   Ignore-Liste für Dict-Keys.
 
+  Default: ``None``
+
+- ``break_on_keynames_problems``
+
+  Wenn ``True`` und Validierungs-Fehler beim Prüfen von Keys gegen
+  ihre Schemata auftreten, brich frühzeitig ab.
+
+  Default: ``True``
+
 
 Typen
 =====
@@ -44,7 +53,7 @@
 
 
 Alle Schemata außer den `Schema-Kombinatoren`_ haben auch ein optionales
-Attribut ``index-constraint``. 
+Attribut ``index-constraint``.
 
   Dessen Wert ist eine Liste von Indizes, an denen das Element in
   seinem Parent-Container (Liste, sorted dict) vorkommen darf.
@@ -520,7 +529,7 @@
 
   - Relative Referenzen *starten* mit einen Punkt (analog Python-Imports)
 
-    Mehrere führende Punkte sind -- wie bei Python-Imports -- relative 
+    Mehrere führende Punkte sind -- wie bei Python-Imports -- relative
     Referenzen zu Parent-Objekten. Der Versuch, den Parent des Root-Objektes
     anzusprechen, liefert einen :py:exc:`TypeError`.