From 505a29e0675aa73d2d3aee0d1520686139a9d26c Mon Sep 17 00:00:00 2001
From: Florian Spreckelsen <f.spreckelsen@indiscale.com>
Date: Thu, 17 Oct 2024 14:10:21 +0200
Subject: [PATCH] DOC: Add explanation on collection_mode to docstring
---
src/caoscrawler/converters/converters.py | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/src/caoscrawler/converters/converters.py b/src/caoscrawler/converters/converters.py
index 83d28cae..874b348c 100644
--- a/src/caoscrawler/converters/converters.py
+++ b/src/caoscrawler/converters/converters.py
@@ -179,7 +179,10 @@ value: Union[dict, str, list]
``collection_mode``. The returned tuple is directly created from
the corresponding values if they are given; ``unit`` defaults to
None and ``collection_mode`` is determined from ``value`` as
- explained for the str case above.
+ explained for the str case above, i.e.,
+ - if it starts with '+', collection mode is "list",
+ - in case of '*', collection mode is "multiproperty",
+ - and everything else is "single".
- If *list*, each element is checked for replacement and the
resulting list will be used as (list) value for the property
--
GitLab