Skip to content

Commit dd0b02c

Browse files
committed
[ModelicaSystem] add missing docstrings
1 parent 792b043 commit dd0b02c

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

OMPython/ModelicaSystem.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,10 @@ def parse_simflags(simflags: str) -> dict[str, Optional[str | dict[str, str]]]:
303303

304304

305305
class ModelicaSystem:
306+
"""
307+
Class to run OpenModelica simulations.
308+
"""
309+
306310
def __init__(
307311
self,
308312
fileName: Optional[str | os.PathLike | pathlib.Path] = None,
@@ -472,6 +476,9 @@ def setTempDirectory(self, customBuildDirectory: Optional[str | os.PathLike | pa
472476
return tempdir
473477

474478
def getWorkDirectory(self) -> OMCPath:
479+
"""
480+
Get the defined working directory of the ModelicaSystem instance.
481+
"""
475482
return self._tempdir
476483

477484
def buildModel(self, variableFilter: Optional[str] = None):

0 commit comments

Comments
 (0)