Skip to content

Commit e06ff5d

Browse files
committed
[ModelicaSystem] update docstring for __init__() and model()
1 parent f4e8758 commit e06ff5d

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
@@ -362,10 +362,7 @@ def __init__(
362362
omhome: Optional[str] = None,
363363
omc_process: Optional[OMCProcessLocal] = None,
364364
) -> None:
365-
"""Initialize, load and build a model.
366-
367-
The constructor loads the model file and builds it, generating exe and
368-
xml files, etc.
365+
"""Create a ModelicaSystem instance. To define the model use model() or convertFmu2Mo().
369366
370367
Args:
371368
commandLineOptions: List with extra command line options as elements. The list elements are
@@ -432,10 +429,9 @@ def model(
432429
variable_filter: Optional[str] = None,
433430
build: bool = True,
434431
) -> None:
435-
"""Initialize, load and build a model.
432+
"""Load and build a Modelica model.
436433
437-
The constructor loads the model file and builds it, generating exe and
438-
xml files, etc.
434+
This method loads the model file and builds it if requested (build == True).
439435
440436
Args:
441437
file: Path to the model file. Either absolute or relative to

0 commit comments

Comments
 (0)