docs: Update docstring with new filter behaviour

datasciencecampus · Sep 18, 2023 · 9cec7a0 · 9cec7a0
1 parent 784114a
commit 9cec7a0
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/transport_performance/osm/osm_utils.py b/src/transport_performance/osm/osm_utils.py
@@ -30,8 +30,8 @@ def filter_osm(
         Bounding box used to perform the filter, in left, bottom, right top
         order. Defaults to [-3.01, 51.58, -2.99, 51.59].
     tag_filter: (bool, optional)
-        Should non-highway ways be filtered? Excludes waterway, landuse &
-        natural. Defaults to True.
+        Should non-highway ways be filtered? Excludes buildings, waterway,
+        landuse & natural. Defaults to True.
     install_osmosis: (bool, optional)
         Should brew be used to install osmosis if not found. Defaults to False.