Skip to content

Commit 9bfc359

Browse files
committed
Added more info on modes
1 parent c27bfb8 commit 9bfc359

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

simvue/run.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,10 @@ def __init__(
9393
Parameters
9494
----------
9595
mode : Literal['online', 'offline', 'disabled'], optional
96-
mode of running, by default "online"
96+
mode of running
97+
online - objects sent directly to Simvue server
98+
offline - everything is written to disk for later dispatch
99+
disabled - disable monitoring completely
97100
"""
98101
self._uuid: str = f"{uuid.uuid4()}"
99102
self._mode: typing.Literal["online", "offline", "disabled"] = mode

0 commit comments

Comments
 (0)