fix: setup_grid docstring updated

Loop3D · Apr 8, 2024 · 67b453b · 67b453b
1 parent 77679a6
commit 67b453b
Showing 1 changed file with 21 additions and 3 deletions.
diff --git a/map2loop/interpolators.py b/map2loop/interpolators.py
@@ -49,7 +49,13 @@ def setup_grid(self, bounding_box: dict):
         abstract method to setup an XY grid (abstract method)
 
         Args:
-            bounding_box (dict): a dictionary containing the bounding box of the map data
+            bounding_box (dict): a dictionary containing the bounding box of the map data.
+            The bounding box dictionary should comply with the following format: {
+                "minx": value,
+                "maxx": value,
+                "miny": value,
+                "maxy": value,
+            }
         """
         pass
 
@@ -218,7 +224,13 @@ def setup_grid(self, bounding_box: dict):
         Setup the grid for interpolation
 
         Args:
-            bounding_box
+            bounding_box (dict): a dictionary containing the bounding box of the map data.
+            The bounding box dictionary should comply with the following format: {
+                "minx": value,
+                "maxx": value,
+                "miny": value,
+                "maxy": value,
+            }
         """
         self.xi, self.yi = setup_grid(bounding_box)
 
@@ -333,7 +345,13 @@ def setup_grid(self, bounding_box: dict):
         Setup the grid for interpolation
 
         Args:
-            bounding_box (dict): a dictionary containing the bounding box of the map data
+            bounding_box (dict): a dictionary containing the bounding box of the map data.
+            The bounding box dictionary should comply with the following format: {
+                "minx": value,
+                "maxx": value,
+                "miny": value,
+                "maxy": value,
+            }
         """
         self.xi, self.yi = setup_grid(bounding_box)