enhance additional_schema documentation

collective · Jan 16, 2024 · 45f9167 · 45f9167
1 parent df9f426
commit 45f9167
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -6,6 +6,8 @@ Changelog
 
 - Fix: Do not fail on `field_remove` or `full_remove` if section or name does not exist. [jensens]
 - Fix: Fail and exit worker if there is `mappings.json` is missing or has a syntax error. [jensens]
+- Enhancement: additional_schema documentation. [jensens]
+
 
 2.0.0 (2023-12-05)
 ------------------

diff --git a/README.rst b/README.rst
@@ -254,7 +254,8 @@ These actions ar available:
 
 ``additional_schema``
     Adds an additional schema to the full schema.
-    The configuration must a valid schema to add.
+    The configuration must a valid schema, i.e. with name and field, to add.
+    In the resulting mapping the schema is added to a (new) section ``additional`` under the subsection ``preprocessed``.
 
 ``rewrite``
     Moves content data from one position in the field-tree to another.