Skip to content

Commit

Permalink
Update evaluator.py
Browse files Browse the repository at this point in the history
Fix an error in documentation
  • Loading branch information
AlexandreDecan committed Jan 2, 2016
1 parent 4aa5b61 commit 962376d
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions sismic/evaluator.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,9 @@ def execute_onexit(self, state: StateMixin):

def evaluate_preconditions(self, obj, event: Event = None) -> list:
"""
Evaluate the preconditions for given object (either a ``ActionStateMixin`` or a
Evaluate the preconditions for given object (either a ``StateMixin`` or a
``Transition``) and return a list of conditions that are not satisfied.
:param obj: the considered state or transition
:param event: an optional ``Event`` instance, in the case of a transition
:return: list of unsatisfied conditions
Expand All @@ -109,8 +110,9 @@ def evaluate_preconditions(self, obj, event: Event = None) -> list:

def evaluate_invariants(self, obj, event: Event = None) -> list:
"""
Evaluate the invariants for given object (either a ``ActionStateMixin`` or a
Evaluate the invariants for given object (either a ``StateMixin`` or a
``Transition``) and return a list of conditions that are not satisfied.
:param obj: the considered state or transition
:param event: an optional ``Event`` instance, in the case of a transition
:return: list of unsatisfied conditions
Expand All @@ -120,8 +122,9 @@ def evaluate_invariants(self, obj, event: Event = None) -> list:

def evaluate_postconditions(self, obj, event: Event = None) -> list:
"""
Evaluate the postconditions for given object (either a ``ActionStateMixin`` or a
Evaluate the postconditions for given object (either a ``StateMixin`` or a
``Transition``) and return a list of conditions that are not satisfied.
:param obj: the considered state or transition
:param event: an optional ``Event`` instance, in the case of a transition
:return: list of unsatisfied conditions
Expand Down

0 comments on commit 962376d

Please sign in to comment.