Add docstring for init request manager

2024-03-11 10:20:47 +00:00
parent 66ab5ec980
commit 1faefbccac
14 changed files with 80 additions and 0 deletions
--- a/src/primaite/simulator/sim_container.py
+++ b/src/primaite/simulator/sim_container.py
@@ -27,6 +27,11 @@ class Simulation(SimComponent):
        self.network.setup_for_episode(episode=episode)

    def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
        rm = super()._init_request_manager()
        # pass through network requests to the network objects
        rm.add_request("network", RequestType(func=self.network._request_manager))