add instruction on entity_alternatives in the docstring of import_data()

spine-tools · Nov 21, 2024 · b5a15c7 · b5a15c7
1 parent 0d0ba88
commit b5a15c7
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/api/db.jl b/src/api/db.jl
@@ -442,7 +442,11 @@ Dict(
     :object_groups => [[:class_name, :group_name, :member_name], ...],
     :scenarios => [(:scen_name, true), ...],  # true for the active flag, not in use at the moment
     :alternatives => [:alt_name, ...],
-    :scenario_alternatives => [(:scen_name, :alt_name, nothing), (:scen_name, :lower_alt_name, :alt_name), ...]
+    :scenario_alternatives => [(:scen_name, :alt_name, nothing), (:scen_name, :lower_alt_name, :alt_name), ...],
+    :entity_alternatives => [
+        [:object_class, :entity_name, :alt_name, true], ...
+        [:multi_d_class, [:entity_name1, :entity_name2], :alt_name, false]
+    ]
 )
 ```