Add docstring for shuffle_do

projectmesa · Sep 21, 2024 · 823fd09 · 823fd09
1 parent 6e25c2a
commit 823fd09
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/mesa/agent.py b/mesa/agent.py
@@ -294,6 +294,10 @@ def do(self, method: str | Callable, *args, **kwargs) -> AgentSet:
         return self
 
     def shuffle_do(self, method: str | Callable, *args, **kwargs) -> AgentSet:
+        """Shuffle the agents in the AgentSet and then invoke a method or function on each agent.
+
+        It's a fast, optimized version of calling shuffle() followed by do().
+        """
         agents = list(self._agents.keys())
         self.random.shuffle(agents)