updated comments

UBCSailbot · Sep 27, 2024 · 3145a2b · 3145a2b
1 parent 3576250
commit 3145a2b
Show file tree

Hide file tree

Showing 2 changed files with 87 additions and 1,650 deletions.
diff --git a/src/local_pathfinding/land/land_polygons_notebook.ipynb b/src/local_pathfinding/land/land_polygons_notebook.ipynb
diff --git a/src/local_pathfinding/local_pathfinding/obstacles.py b/src/local_pathfinding/local_pathfinding/obstacles.py
@@ -142,8 +142,8 @@ def _update_land_collision_zone(
     ) -> None:
         """
         Updates the Land object's collision zone with a MultiPolygon representing
-        all land obstacles within either a bounding box input as an argument
-        or a rectangle that bounds boxes around Sailbot and the next global waypoint.
+        all land obstacles within either a state_space input as an argument
+        or a default rectangle that bounds boxes around Sailbot and the next global waypoint.
         """
         if land_multi_polygon is not None:  # for testing
 
@@ -174,7 +174,6 @@ def _update_land_collision_zone(
 
         if len(collision_zone.geoms) > 0:
             # if collision_zone is empty, buffer(0) will return an empty Polygon
-            # not a MultiPolygon
             # buffer(0) will repair invalid/overlapping geometry
             # otherwise we cant run .contains() on it
             collision_zone = collision_zone.buffer(0)