Skip to content

Commit 8540164

Browse files
committed
[ModelicaSystem] update docstring for __init__() and model()
1 parent 4ff2504 commit 8540164

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
@@ -329,10 +329,7 @@ def __init__(
329329
omhome: Optional[str] = None,
330330
omc_process: Optional[OMCProcess] = None,
331331
) -> None:
332-
"""Initialize, load and build a model.
333-
334-
The constructor loads the model file and builds it, generating exe and
335-
xml files, etc.
332+
"""Create a ModelicaSystem instance. To define the model use model() or convertFmu2Mo().
336333
337334
Args:
338335
commandLineOptions: List with extra command line options as elements. The list elements are
@@ -397,10 +394,9 @@ def model(
397394
variable_filter: Optional[str] = None,
398395
build: bool = True,
399396
) -> None:
400-
"""Initialize, load and build a model.
397+
"""Load and build a Modelica model.
401398
402-
The constructor loads the model file and builds it, generating exe and
403-
xml files, etc.
399+
This method loads the model file and builds it if requested (build == True).
404400
405401
Args:
406402
file: Path to the model file. Either absolute or relative to

0 commit comments

Comments
 (0)