From 4ead9298e4057473617a08adab68849f9cfce7ed Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Wed, 30 Mar 2022 12:36:33 +0200
Subject: [PATCH] DOC: Documentation improved a bit.
---
CHANGELOG.md | 4 ++--
integrationtests/test.sh | 3 ++-
src/doc/yaml_interface.rst | 5 +++--
3 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index f69e155e..018d8876 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -25,8 +25,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed ###
-- CaosDB internal properties `name` and `unit` can now be used via the `extern`
- keyword in yaml datamodel specifications.
+- CaosDB internal properties `name`, `unit` and `description` can now be used via the `extern`
+ keyword in YAML datamodel specifications.
### Security ###
diff --git a/integrationtests/test.sh b/integrationtests/test.sh
index e9759698..aebec016 100755
--- a/integrationtests/test.sh
+++ b/integrationtests/test.sh
@@ -57,10 +57,11 @@ then
exit 1
fi
set -e
-echo "undo changes"
+echo "Undoing previous changes to extroot content..."
cd extroot
egrep -liRZ 'A description of this example' . | xargs -0 -l sed -i -e 's/A description of this example/A description of another example/g'
cd ..
+echo "Done."
python3 test_table.py
# TODO the following test deletes lots of the data inserted by the crawler
echo "Testing im and export"
diff --git a/src/doc/yaml_interface.rst b/src/doc/yaml_interface.rst
index dcf4c5d6..476e9282 100644
--- a/src/doc/yaml_interface.rst
+++ b/src/doc/yaml_interface.rst
@@ -50,7 +50,7 @@ This example defines 3 ``RecordType``s:
- A Person with a ``firstName`` and a ``lastName`` (as recommended properties)
- A ``LabbookEntry`` with multiple recommended properties of different data types
- It is assumed that the server knows a RecordType or Property with the name
- "Textfile".
+ ``Textfile``.
One major advantage of using this interface (in contrast to the standard python interface) is that properties can be defined and added to record types "on-the-fly". E.g. the three lines for ``firstName`` as sub entries of ``Person`` have two effects on CaosDB:
@@ -66,7 +66,8 @@ Note the difference between the three property declarations of ``LabbookEntry``:
- ``responsible``: This defines and adds a property with name "responsible" to ``LabbookEntry`, which has a datatype ``Person``. ``Person`` is defined above.
- ``firstName``: This defines and adds a property with the standard data type ``TEXT`` to record type ``Person``.
-If the data model depends on already existing parts, those can be added using the ``extern`` keyword.
+If the data model depends on record types or properties which already exist in CaosDB, those can be
+added using the ``extern`` keyword: ``extern`` takes a list of previously defined names.
Datatypes
---------
--
GitLab