Deprecate SingleGrid.position_agent (projectmesa#1512)

jeanremacle · Nov 6, 2022 · 45171f3 · 45171f3
1 parent bfca50c
commit 45171f3
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/examples/schelling/model.py b/examples/schelling/model.py
@@ -70,7 +70,7 @@ def __init__(self, width=20, height=20, density=0.8, minority_pc=0.2, homophily=
                     agent_type = 0
 
                 agent = SchellingAgent((x, y), self, agent_type)
-                self.grid.position_agent(agent, x, y)
+                self.grid.place_agent(agent, (x, y))
                 self.schedule.add(agent)
 
         self.running = True

diff --git a/mesa/space.py b/mesa/space.py
@@ -504,6 +504,16 @@ def position_agent(
         If x or y are positive, they are used.
         Use 'swap_pos()' to swap agents positions.
         """
+        warn(
+            (
+                "`position_agent` is being deprecated; use instead "
+                "`place_agent` to place an agent at a specified "
+                "location or `move_to_empty` to place an agent "
+                "at a random empty cell."
+            ),
+            DeprecationWarning,
+        )
+
         if not (isinstance(x, int) or x == "random"):
             raise Exception(
                 "x must be an integer or a string 'random'."