Skip to content

Commit a84141b

Browse files
committed
Improve docstrings
1 parent 8e46e5d commit a84141b

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()
@@ -851,10 +849,10 @@ def simulate(self,
851849
852850
Args:
853851
resultfile: Path to a custom result file
854-
simflags: String of space separated simulation runtime flags.
852+
simflags: String of extra command line flags for the model binary.
855853
This argument is deprecated, use simargs instead.
856854
simargs: Dict with simulation runtime flags.
857-
timeout: Execution timeout in seconds.
855+
timeout: Maximum execution time in seconds.
858856
859857
Examples:
860858
mod.simulate()
@@ -1244,10 +1242,10 @@ def linearize(self, lintime: Optional[float] = None, simflags: Optional[str] = N
12441242
12451243
Args:
12461244
lintime: Override "stopTime" value.
1247-
simflags: A string of extra command line flags for the model
1248-
binary. - depreciated in favor of simargs
1245+
simflags: String of extra command line flags for the model binary.
1246+
This argument is deprecated, use simargs instead.
12491247
simargs: A dict with command line flags and possible options; example: "simargs={'csvInput': 'a.csv'}"
1250-
timeout: Execution timeout in seconds.
1248+
timeout: Maximum execution time in seconds.
12511249
12521250
Returns:
12531251
A LinearizationResult object is returned. This allows several

0 commit comments

Comments
 (0)