docs(init_agent): fix misleading comment in docstring about calling s…

…equence
Met4FoF · Oct 12, 2023 · 6eeb0fa · 6eeb0fa
1 parent 211d45f
commit 6eeb0fa
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/agentMET4FOF/agents/base_agents.py b/agentMET4FOF/agents/base_agents.py
@@ -134,10 +134,9 @@ def get_attr(self, attr):
         return getattr(self, attr)
 
     def init_agent(self, buffer_size=1000, log_mode=True):
-        """
-        Internal initialization to setup the agent: mainly on setting the dictionary
-        of Inputs, Outputs, PubAddr. Calls user-defined `init_parameters()` upon
-        finishing.
+        """Internal initialization to set up the agent
+
+        This mainly sets the dictionaries of inputs, outputs and the public address.
 
         Attributes
         ----------