From 7e64acd36840363be507ea36924d4eeb93f2a07e Mon Sep 17 00:00:00 2001 From: Marek Wolan Date: Mon, 21 Aug 2023 10:04:23 +0100 Subject: [PATCH] Update container docstrings --- src/primaite/simulator/network/container.py | 3 ++- src/primaite/simulator/sim_container.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/primaite/simulator/network/container.py b/src/primaite/simulator/network/container.py index 463d5f91..f89ed2d3 100644 --- a/src/primaite/simulator/network/container.py +++ b/src/primaite/simulator/network/container.py @@ -5,12 +5,13 @@ from primaite.simulator.network.hardware.base import Link, Node class NetworkContainer(SimComponent): - """TODO.""" + """Top level container object representing the physical network.""" nodes: Dict[str, Node] = {} links: Dict[str, Link] = {} def __init__(self, **kwargs): + """Initialise the network.""" super().__init__(**kwargs) self.action_manager = ActionManager() diff --git a/src/primaite/simulator/sim_container.py b/src/primaite/simulator/sim_container.py index 1a37dc18..50fe412c 100644 --- a/src/primaite/simulator/sim_container.py +++ b/src/primaite/simulator/sim_container.py @@ -6,12 +6,13 @@ from primaite.simulator.network.container import NetworkContainer class Simulation(SimComponent): - """TODO.""" + """Top-level simulation object which holds a reference to all other parts of the simulation.""" network: NetworkContainer domain: DomainController def __init__(self, **kwargs): + """Initialise the Simulation.""" if not kwargs.get("network"): kwargs["network"] = NetworkContainer()