Skip to content

Commit 8580b46

Browse files
committed
[OMCSessionRunData] update docstring and comments
1 parent 53eead0 commit 8580b46

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

OMPython/OMCSession.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -460,14 +460,15 @@ class OMCPathCompatibilityWindows(pathlib.WindowsPath, OMCPathCompatibility):
460460
class OMCSessionRunData:
461461
"""
462462
Data class to store the command line data for running a model executable in the OMC environment.
463+
464+
All data should be defined for the environment, where OMC is running (local, docker or WSL)
463465
"""
464-
# cmd_path is based on the selected OMCProcess definition
466+
# cmd_path is the expected working directory
465467
cmd_path: str
466468
cmd_model_name: str
467469
# command line arguments for the model executable
468470
cmd_args: list[str]
469471
# result file with the simulation output
470-
# cmd_result_path is based on the selected OMCProcess definition
471472
cmd_result_path: str
472473

473474
# command prefix data (as list of strings); needed for docker or WSL

0 commit comments

Comments
 (0)