Skip to content

Commit 04ff824

Browse files
committed
[ModelicaSystem] update docstring for __init__() and model()
1 parent 901d999 commit 04ff824

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
@@ -316,10 +316,7 @@ def __init__(
316316
omhome: Optional[str] = None,
317317
omc_process: Optional[OMCProcessLocal] = None,
318318
) -> None:
319-
"""Initialize, load and build a model.
320-
321-
The constructor loads the model file and builds it, generating exe and
322-
xml files, etc.
319+
"""Create a ModelicaSystem instance. To define the model use model() or convertFmu2Mo().
323320
324321
Args:
325322
commandLineOptions: List with extra command line options as elements. The list elements are
@@ -386,10 +383,9 @@ def model(
386383
variable_filter: Optional[str] = None,
387384
build: bool = True,
388385
) -> None:
389-
"""Initialize, load and build a model.
386+
"""Load and build a Modelica model.
390387
391-
The constructor loads the model file and builds it, generating exe and
392-
xml files, etc.
388+
This method loads the model file and builds it if requested (build == True).
393389
394390
Args:
395391
file: Path to the model file. Either absolute or relative to

0 commit comments

Comments
 (0)