Improve zino1 controller docstring

Uninett · May 31, 2024 · d5be2de · d5be2de
1 parent 52fd734
commit d5be2de
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/zinolib/controllers/zino1.py b/src/zinolib/controllers/zino1.py
@@ -2,7 +2,7 @@
 Get a live Zino 1 session to use::
 
     > from zinolib.config.zino1 import ZinoV1Config
-    > from zinolib.zino1 import Zino1EventManager
+    > from zinolib.controllers.zino1 import Zino1EventManager
     > config = ZinoV1Config.from_tcl('.ritz.tcl', 'default')
     > event_manager = Zino1EventManager.configure(config)
     > event_manager.connect()
@@ -11,6 +11,13 @@
 
     > config = ZinoV1Config.from_toml('.ritz.toml', 'default')
 
+.. or in a dict with the format::
+
+    > config_dict = {"connections": "default": { "server": ACTUAL CONFIG .. }}
+    > config = ZinoV1Config.from_dict(config_dict, 'default')
+
+Do not initialize ZinoV1Config directly, avoid ``ZinoV1Config(**dict)``.
+
 Authenticate using a username and password from the config-file::
 
     > event_manager.authenticate()