Skip to content

Commit 8feeff7

Browse files
committed
[ModelicaSystem] update docstring for __init__() and model()
1 parent efd7f88 commit 8feeff7

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

OMPython/ModelicaSystem.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -360,10 +360,7 @@ def __init__(
360360
omhome: Optional[str] = None,
361361
omc_process: Optional[OMCProcessLocal] = None,
362362
) -> None:
363-
"""Initialize, load and build a model.
364-
365-
The constructor loads the model file and builds it, generating exe and
366-
xml files, etc.
363+
"""Create a ModelicaSystem instance. To define the model use model() or convertFmu2Mo().
367364
368365
Args:
369366
commandLineOptions: List with extra command line options as elements. The list elements are
@@ -430,10 +427,9 @@ def model(
430427
variable_filter: Optional[str] = None,
431428
build: bool = True,
432429
) -> None:
433-
"""Initialize, load and build a model.
430+
"""Load and build a Modelica model.
434431
435-
The constructor loads the model file and builds it, generating exe and
436-
xml files, etc.
432+
This method loads the model file and builds it if requested (build == True).
437433
438434
Args:
439435
file: Path to the model file. Either absolute or relative to

0 commit comments

Comments
 (0)