Skip to content

Commit 7504e63

Browse files
committed
[ModelicaSystem] update docstring for __init__() and model()
1 parent fc12bd2 commit 7504e63

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

OMPython/ModelicaSystem.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -319,10 +319,7 @@ def __init__(
319319
omhome: Optional[str] = None,
320320
omc_process: Optional[OMCProcess] = None,
321321
) -> None:
322-
"""Initialize, load and build a model.
323-
324-
The constructor loads the model file and builds it, generating exe and
325-
xml files, etc.
322+
"""Create a ModelicaSystem instance. To define the model use model() or convertFmu2Mo().
326323
327324
Args:
328325
commandLineOptions: List with extra command line options as elements. The list elements are
@@ -387,10 +384,9 @@ def model(
387384
variable_filter: Optional[str] = None,
388385
build: bool = True,
389386
) -> None:
390-
"""Initialize, load and build a model.
387+
"""Load and build a Modelica model.
391388
392-
The constructor loads the model file and builds it, generating exe and
393-
xml files, etc.
389+
This method loads the model file and builds it if requested (build == True).
394390
395391
Args:
396392
file: Path to the model file. Either absolute or relative to

0 commit comments

Comments
 (0)