Clarify ContinuousSpace.get_neighbors behavior with multiple agents at same position

mesa/examples/basic/boid_flockers/agents.py

@@ -58,7 +58,8 @@ def __init__(
 
     def step(self):
         """Get the Boid's neighbors, compute the new vector, and move accordingly."""
-        self.neighbors = self.model.space.get_neighbors(self.pos, self.vision, False)
+        neighbors = self.model.space.get_neighbors(self.pos, self.vision, True)
+        self.neighbors = [n for n in neighbors if n is not self]
 
         # If no neighbors, maintain current direction
         if not self.neighbors:

mesa/space.py

@@ -1415,6 +1415,13 @@ def get_neighbors(
                             coordinates. i.e. if you are searching for the
                             neighbors of a given agent, True will include that
                             agent in the results.
+
+        Notes:
+            If 1 or more agents are located on pos, include_center=True will remove these agents
+            from the results. So, if you really want to get the neighbors of a given agent,
+            you should set include_center to true and filter the list of agents to remove
+            the given agent.
+
         """
         if self._agent_points is None:
             self._build_agent_cache()