Minor fixes based on code review

2023-12-15 13:09:50 +00:00
parent 6a80f4cc77
commit 7a1abb1ef8
2 changed files with 4 additions and 4 deletions
--- a/src/primaite/game/agent/observations.py
+++ b/src/primaite/game/agent/observations.py
@@ -346,7 +346,7 @@ class NicObservation(AbstractObservation):

        :param where: Where in the simulation state dictionary to find the relevant information for this NIC. A typical
            example may look like this:
-            ['network','nodes',<node_hostname>,'NICs',<nic_index>]
+            ['network','nodes',<node_hostname>,'NICs',<nic_number>]
            If None, this denotes that the NIC does not exist and the observation will be populated with zeroes.
        :type where: Optional[Tuple[str]], optional
        """