Skip to content

Commit e9e4d0f

Browse files
committed
src/sim_explorer/system_interface.py: Minor docstring improvement
1 parent e04cbff commit e9e4d0f

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

src/sim_explorer/system_interface.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -367,14 +367,18 @@ def allowed_action( # noqa: C901
367367
) -> bool:
368368
"""Check whether the action would be allowed according to FMI2 rules, see FMI2.01, p.49.
369369
370-
* if a tuple of variables is provided, the variables shall have equal properties
371-
in addition to the normal allowed rules.
370+
Note: If a tuple of variables is provided, the variables shall have equal properties
371+
in addition to the normal allowed rules.
372372
373373
Args:
374374
action (str): Action type, 'set', 'get', including init actions (set at time 0)
375375
comp (int,str): The instantiated component within the system (as index or name)
376-
var (int,str,tuple): The variable(s) (of component) as reference or name
376+
var (int,str,Sequence[int], Sequence[str]): The variable(s) (of component) as reference or name
377377
time (float): The time at which the action will be performed
378+
379+
Returns
380+
-------
381+
True if the action is allowed, False otherwise. In case of False, self.message contains the reason.
378382
"""
379383

380384
def _description(

0 commit comments

Comments
 (0)