From 0439c3159e5948a8a7a36501aa835840e39d4fe2 Mon Sep 17 00:00:00 2001 From: Charlie Crane Date: Fri, 15 Nov 2024 17:40:11 +0000 Subject: [PATCH] #2912 - Minor update to extensible actions documentation and moved old actions into _legacy --- docs/source/how_to_guides/extensible_actions.rst | 2 ++ src/primaite/{game/agent => _legacy}/actions.py | 0 2 files changed, 2 insertions(+) rename src/primaite/{game/agent => _legacy}/actions.py (100%) diff --git a/docs/source/how_to_guides/extensible_actions.rst b/docs/source/how_to_guides/extensible_actions.rst index bd78c8e1..576aa75f 100644 --- a/docs/source/how_to_guides/extensible_actions.rst +++ b/docs/source/how_to_guides/extensible_actions.rst @@ -25,8 +25,10 @@ New actions to be used within PrimAITE require: .. code-block:: python class ExampleAction(AbstractAction, identifier="Example_action"): + """An example action for demonstration purposes.""" class ConfigSchema(AbstractAction.ConfigSchema): + """The configuration schema with all attributes expected goes here.""" target_application: str The ConfigSchema is used when the class is called to form the action, within the `form_request` method, detailed below. diff --git a/src/primaite/game/agent/actions.py b/src/primaite/_legacy/actions.py similarity index 100% rename from src/primaite/game/agent/actions.py rename to src/primaite/_legacy/actions.py