Add docstring for init request manager

src/primaite/simulator/network/container.py

@@ -61,6 +61,11 @@ class Network(SimComponent):
                     software.run()
 
     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()
         self._node_request_manager = RequestManager()
         rm.add_request(

src/primaite/simulator/network/hardware/base.py

@@ -114,6 +114,11 @@ class NetworkInterface(SimComponent, ABC):
         self.enable()
 
     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()
 
         rm.add_request("enable", RequestType(func=lambda request, context: RequestResponse.from_bool(self.enable())))
@@ -786,6 +791,11 @@ class Node(SimComponent):
             return self.node.operating_state == NodeOperatingState.ON
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         _node_is_on = Node._NodeIsOnValidator(node=self)
 
         rm = super()._init_request_manager()

src/primaite/simulator/network/hardware/nodes/network/router.py

@@ -294,6 +294,11 @@ class AccessControlList(SimComponent):
         self._acl = [None] * (self.max_acl_rules - 1)
 
     def _init_request_manager(self) -> RequestManager:
+        """
+        Initialise the request manager.
+
+        More information in user guide and docstring for SimComponent._init_request_manager.
+        """
         # TODO: Add src and dst wildcard masks as positional args in this request.
         rm = super()._init_request_manager()
 
@@ -1092,6 +1097,11 @@ class Router(NetworkNode):
         super().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()
         rm.add_request("acl", RequestType(func=self.acl._request_manager))
         return rm