From 02901a7c99e2bc5bfe7e9bf281c51a8aee746d84 Mon Sep 17 00:00:00 2001 From: Marek Wolan Date: Wed, 25 Oct 2023 19:07:45 +0100 Subject: [PATCH] Apply suggestions from code review. --- docs/index.rst | 2 +- docs/source/config(v2).rst | 2 ++ src/primaite/game/agent/actions.py | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 22e880fc..ed66797d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -98,7 +98,7 @@ Head over to the :ref:`getting-started` page to install and setup PrimAITE! source/getting_started source/about source/config - source/config(v3) + source/config(v2) source/simulation source/game_layer source/primaite_session diff --git a/docs/source/config(v2).rst b/docs/source/config(v2).rst index daf7f90b..35233cf5 100644 --- a/docs/source/config(v2).rst +++ b/docs/source/config(v2).rst @@ -7,6 +7,8 @@ The Config Files Explained ========================== +Note: This file describes the config files used in legacy PrimAITE v2.0. This file will be removed soon. + PrimAITE uses two configuration files for its operation: * **The Training Config** diff --git a/src/primaite/game/agent/actions.py b/src/primaite/game/agent/actions.py index 0a380487..b06013cd 100644 --- a/src/primaite/game/agent/actions.py +++ b/src/primaite/game/agent/actions.py @@ -697,7 +697,7 @@ class ActionManager: def get_action(self, action: int) -> Tuple[str, Dict]: """Produce action in CAOS format.""" """the agent chooses an action (as an integer), this is converted into an action in CAOS format""" - """The caos format is basically a action identifier, followed by parameters stored in a dictionary""" + """The CAOS format is basically a action identifier, followed by parameters stored in a dictionary""" act_identifier, act_options = self.action_map[action] return act_identifier, act_options