Added info about what id is for device config about YAML for CLI

Aharoni-Lab · Dec 12, 2024 · 79d6ea3 · 79d6ea3
1 parent 920d795
commit 79d6ea3
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/mio/cli/stream.py b/mio/cli/stream.py
@@ -26,7 +26,8 @@ def _common_options(fn: Callable) -> Callable:
         "--device_config",
         required=True,
         help=(
-            "Either a config `id` or a path to device config YAML file for streamDaq "
+            "Either a config `id` or a path to device config YAML file for streamDaq. "
+            "This is currently the id located in the first line of the YAML config file "
             "(see models.stream.StreamDevConfig). If path is relative, treated as "
             "relative to the current directory, and then if no matching file is found, "
             "relative to the user `config_dir` (see `mio config --help`)."