doc string updates for time slice argument

NREL · Nov 6, 2024 · 721adb1 · 721adb1
1 parent 34760ba
commit 721adb1
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/sup3r/preprocessing/data_handlers/factory.py b/sup3r/preprocessing/data_handlers/factory.py
@@ -88,10 +88,11 @@ def __init__(
             or raster_file.
         shape : tuple
             (rows, cols) grid size. Either need target+shape or raster_file.
-        time_slice : slice
+        time_slice : slice | list
             Slice specifying extent and step of temporal extraction. e.g.
-            slice(start, stop, step). If equal to slice(None, None, 1) the
-            full time dimension is selected.
+            slice(start, stop, step). If equal to slice(None, None, 1) the full
+            time dimension is selected. Can be also be a list ``[start, stop,
+            step]``
         threshold : float
             Nearest neighbor euclidean distance threshold. If the coordinates
             are more than this value away from the target lat/lon, an error is

diff --git a/sup3r/preprocessing/rasterizers/base.py b/sup3r/preprocessing/rasterizers/base.py
@@ -51,10 +51,11 @@ def __init__(
             raster_file.
         shape : tuple
             (rows, cols) grid size. Either need target+shape or raster_file.
-        time_slice : slice
+        time_slice : slice | list
             Slice specifying extent and step of temporal extraction. e.g.
             slice(start, stop, step). If equal to slice(None, None, 1) the full
-            time dimension is selected.
+            time dimension is selected. Can be also be a list ``[start, stop,
+            step]``
         threshold : float
             Nearest neighbor euclidean distance threshold. If the coordinates
             are more than this value away from the target lat/lon, an error is

diff --git a/sup3r/preprocessing/rasterizers/extended.py b/sup3r/preprocessing/rasterizers/extended.py
@@ -58,10 +58,11 @@ def __init__(
         shape : tuple
             (rows, cols) grid size. Either need target+shape or
             raster_file.
-        time_slice : slice
+        time_slice : slice | list
             Slice specifying extent and step of temporal extraction. e.g.
-            slice(start, stop, step). If equal to slice(None, None, 1) the
-            full time dimension is selected.
+            slice(start, stop, step). If equal to slice(None, None, 1) the full
+            time dimension is selected. Can be also be a list ``[start, stop,
+            step]``
         threshold : float
             Nearest neighbor euclidean distance threshold. If the
             coordinates are more than this value away from the target