Skip to content

Commit

Permalink
refactoring: comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuel Gobbi committed Dec 3, 2024
1 parent 3a55007 commit 3e8b551
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 13 deletions.
2 changes: 1 addition & 1 deletion unified_planning/io/pddl_writer.py
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ def _write_domain(self, out: IO[str]):
)
costs: Dict[
Union[up.model.NaturalTransition, up.model.Action], Optional[up.model.FNode]
] = {} # TODO check if natural_transition should be here
] = {}
metrics = self.problem.quality_metrics
if len(metrics) == 1:
metric = metrics[0]
Expand Down
4 changes: 1 addition & 3 deletions unified_planning/model/action.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@
# limitations under the License.
#
"""
This module defines the `Action` base class and some of his extensions.
An `Action` has a `name`, a `list` of `Parameter`, a `list` of `preconditions`
and a `list` of `effects`.
This module defines the `Action` class and some of his extensions.
"""


Expand Down
12 changes: 3 additions & 9 deletions unified_planning/model/natural_transition.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,11 @@

from unified_planning.model.transition import Transition

# TODO fix comments here
# TODO check weather events/processes should have all the methods/other stuff that actions have. If yes, we need more tests.
# TODO check weather events/processes should have all the methods/other stuff that actions have.
# If yes, we probably need more tests for better coverage

"""
This module defines the `NaturalTransition` class and some of his extensions.
An `NaturalTransition` has a `name`, a `list` of `Parameter`, a `list` of `preconditions`
and a `list` of `effects`.
"""

"""
Below we have natural transitions. These are not controlled by the agent and would probably need a proper subclass. Natural transitions can be of two kinds:
Below we have natural transitions. These are not controlled by the agent. Natural transitions can be of two kinds:
Processes or Events.
Processes dictate how numeric variables evolve over time through the use of time-derivative functions
Events dictate the analogous of urgent transitions in timed automata theory
Expand Down

0 comments on commit 3e8b551

Please sign in to comment.