Merge pull request #1105 from gboeing/dep

deprecate return_coords argument in graph_from_address function

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 - fix a bug in the features module's polygon handling (#1104)
+- deprecate return_coords argument in graph.graph_from_address function (#1105)
 
 ## 1.8.1 (2023-12-31)
 

osmnx/graph.py

@@ -202,7 +202,7 @@ def graph_from_address(
     simplify=True,
     retain_all=False,
     truncate_by_edge=False,
-    return_coords=False,
+    return_coords=None,
     clean_periphery=None,
     custom_filter=None,
 ):
@@ -236,7 +236,7 @@ def graph_from_address(
         if True, retain nodes outside bounding box if at least one of node's
         neighbors is within the bounding box
     return_coords : bool
-        optionally also return the geocoded coordinates of the address
+        deprecated, do not use
     clean_periphery : bool
         deprecated, do not use
     custom_filter : string
@@ -255,6 +255,15 @@ def graph_from_address(
     function to automatically make multiple requests: see that function's
     documentation for caveats.
     """
+    if return_coords is None:
+        return_coords = False
+    else:
+        warn(
+            "The `return_coords` argument has been deprecated and will be removed in "
+            "a future release. Future behavior will be as though `return_coords=False`. "
+            "If you want the address's geocoded coordinates, use the `geocode` module.",
+            stacklevel=2,
+        )
     # geocode the address string to a (lat, lon) point
     point = geocoder.geocode(query=address)