Skip to content

Commit 73fb34a

Browse files
committed
Improve docstrings
1 parent 7ca5013 commit 73fb34a

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

OMPython/ModelicaSystem.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,7 @@ def __getitem__(self, index: int):
113113

114114

115115
class ModelicaSystemCmd:
116-
"""
117-
Execute a simulation by running the compiled model.
118-
"""
116+
"""A compiled model executable."""
119117

120118
def __init__(self, runpath: pathlib.Path, modelname: str, timeout: Optional[float] = None) -> None:
121119
self._runpath = pathlib.Path(runpath).resolve().absolute()
@@ -817,10 +815,10 @@ def simulate(self,
817815
818816
Args:
819817
resultfile: Path to a custom result file
820-
simflags: String of space separated simulation runtime flags.
818+
simflags: String of extra command line flags for the model binary.
821819
This argument is deprecated, use simargs instead.
822820
simargs: Dict with simulation runtime flags.
823-
timeout: Execution timeout in seconds.
821+
timeout: Maximum execution time in seconds.
824822
825823
Examples:
826824
mod.simulate()
@@ -1210,10 +1208,10 @@ def linearize(self, lintime: Optional[float] = None, simflags: Optional[str] = N
12101208
12111209
Args:
12121210
lintime: Override "stopTime" value.
1213-
simflags: A string of extra command line flags for the model
1214-
binary. - depreciated in favor of simargs
1211+
simflags: String of extra command line flags for the model binary.
1212+
This argument is deprecated, use simargs instead.
12151213
simargs: A dict with command line flags and possible options; example: "simargs={'csvInput': 'a.csv'}"
1216-
timeout: Execution timeout in seconds.
1214+
timeout: Maximum execution time in seconds.
12171215
12181216
Returns:
12191217
A LinearizationResult object is returned. This allows several

0 commit comments

Comments
 (0)