diff docs/schema.txt @ 19:c3a0fe8d4587

Consistent casing of schema items: all lowercase with dash as separator
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 08 Jul 2023 10:05:48 +0200
parents 84dfd1a94926
children 449f7c8ede19
line wrap: on
line diff
--- a/docs/schema.txt	Fri Jul 07 09:27:51 2023 +0200
+++ b/docs/schema.txt	Sat Jul 08 10:05:48 2023 +0200
@@ -62,14 +62,14 @@
   `dict` mit Keys und den Values als zugeordnete Schemata für die Values
   des Dicts
 
-- ``keyNames``
+- ``key-names``
 
-  Wenn vorhanden: ein Schema, dem die *Keys* -- auch die `additionalKeys` --
+  Wenn vorhanden: ein Schema, dem die *Keys* -- auch die `additional-keys` --
   folgen müssen.
 
   Default: entspricht ``{"type": "string"}``
 
-- ``additionalKeys``
+- ``additional-keys``
 
   * bool
 
@@ -94,8 +94,8 @@
 
   Liste von Strings mit Key-Namen, die vorkommen müssen
 
-- ``maxLength``
-- ``minLength``
+- ``max-length``
+- ``min-length``
 
 
 list / array
@@ -109,8 +109,8 @@
 
   Ein Schema für *alle* Items.
 
-- ``maxLength``
-- ``minLength``
+- ``max-length``
+- ``min-length``
 
 
 set / frozenset
@@ -124,8 +124,8 @@
 
   Ein Schema für *alle* Items
 
-- ``maxLength``
-- ``minLength``
+- ``max-length``
+- ``min-length``
 
 
 tuple / record
@@ -140,7 +140,7 @@
 
   Eine Liste: je ein spezielles Schema *pro Item*
 
-- ``additionalItems``
+- ``additional-items``
 
   * bool
 
@@ -154,8 +154,8 @@
 
     Prüfung der "zusätzlichen" Items erfolgt nach gegebenem Schema
 
-- ``maxLength``
-- ``minLength``
+- ``max-length``
+- ``min-length``
 
 
 string / str
@@ -177,8 +177,8 @@
   The string's value must be contained in (Python ``in``) in the referenced
   object (see `Referenzen`_).
 
-- ``maxLength``
-- ``minLength``
+- ``max-length``
+- ``min-length``
 - ``pattern``
 
   * string
@@ -195,8 +195,8 @@
 binary
 ------
 
-- ``maxLength``
-- ``minLength``
+- ``max-length``
+- ``min-length``
 - ``pattern``
 
   * string
@@ -280,8 +280,8 @@
 
   bool (Default: False): allow also a None/null/nil
 
-- ``minValue``
-- ``maxValue``
+- ``min-value``
+- ``max-value``
 - ``value``
 
   A callable to validate the integer value
@@ -291,7 +291,7 @@
   Eine Liste von ganzen Zahlen, von denen genau einer dem vorhandenen
   Wert entsprechen muß.
 
-  Achtung: Alle anderen Prüfungen (`minValue`, `maxValue`, `value`)
+  Achtung: Alle anderen Prüfungen (`min-value`, `max-value`, `value`)
            werden trotzdem auch durchgeführt.
 
 
@@ -302,8 +302,8 @@
 
   bool (Default: False): allow also a None/null/nil
 
-- ``minValue``
-- ``maxValue``
+- ``min-value``
+- ``max-value``
 - ``value``
 
   A callable to validate the float value
@@ -318,8 +318,8 @@
 
 Any numeric value (int or float)
 
-- ``minValue``
-- ``maxValue``
+- ``min-value``
+- ``max-value``
 - ``value``
 
   A callable to validate the number
@@ -329,7 +329,7 @@
   Eine Liste von Zahlen, von denen genau einer dem vorhandenen
   Wert entsprechen muß.
 
-  Achtung: Alle anderen Prüfungen (`minValue`, `maxValue`, `value`)
+  Achtung: Alle anderen Prüfungen (`min-value`, `max-value`, `value`)
            werden trotzdem auch durchgeführt.