work on docstrings

Author: philipc2

uxarray/subset/dataarray_accessor.py

@@ -132,20 +132,20 @@ def constant_latitude(
         inverse_indices: Union[List[str], Set[str], bool] = False,
         lon_range: Tuple[float, float] = (-180, 180),
     ):
-        """Extracts a cross-section of the data array across a line of constant-latitude.
+        """Extracts a subset of the data array across a line of constant-latitude.
 
         Parameters
         ----------
         lat : float
-            The latitude at which to extract the cross-section, in degrees.
+            The latitude at which to extract the subset, in degrees.
             Must be between -90.0 and 90.0
         inverse_indices : Union[List[str], Set[str], bool], optional
             Controls storage of original grid indices. Options:
             - True: Stores original face indices
             - List/Set of strings: Stores specified index types (valid values: "face", "edge", "node")
             - False: No index storage (default)
         lon_range: Tuple[float, float], optional
-            `(min_lon, max_lon)` longitude values to perform the cross-section. Values must lie in [-180, 180]. Default is `(-180, 180)`.
+            `(min_lon, max_lon)` longitude values to perform the subset. Values must lie in [-180, 180]. Default is `(-180, 180)`.
 
         Returns
         -------
@@ -192,7 +192,7 @@ def constant_longitude(
         inverse_indices: Union[List[str], Set[str], bool] = False,
         lat_range: Tuple[float, float] = (-90, 90),
     ):
-        """Extracts a cross-section of the data array across a line of constant-longitude.
+        """Extracts a subset of the data array across a line of constant-longitude.
 
         This method supports two modes:
           - **grid‐based** (`interpolate=False`, the default): returns exactly those faces
@@ -203,15 +203,15 @@ def constant_longitude(
         Parameters
         ----------
         lon : float
-            The longitude at which to extract the cross-section, in degrees.
+            The longitude at which to extract the subset, in degrees.
             Must be between -180.0 and 180.0
         inverse_indices : Union[List[str], Set[str], bool], optional
             Controls storage of original grid indices. Options:
             - True: Stores original face indices
             - List/Set of strings: Stores specified index types (valid values: "face", "edge", "node")
             - False: No index storage (default)
         lat_range: Tuple[float, float], optional
-            `(min_lat, max_lat)` latitude values to perform the cross-section. Values must lie in [-90, 90]. Default is `(-90, 90)`.
+            `(min_lat, max_lat)` latitude values to perform the subset. Values must lie in [-90, 90]. Default is `(-90, 90)`.
 
         Returns
         -------
@@ -258,13 +258,13 @@ def constant_latitude_interval(
         lats: Tuple[float, float],
         inverse_indices: Union[List[str], Set[str], bool] = False,
     ):
-        """Extracts a cross-section of data by selecting all faces that
+        """Extracts a subset of data by selecting all faces that
         are within a specified latitude interval.
 
         Parameters
         ----------
         lats : Tuple[float, float]
-            The latitude interval (min_lat, max_lat) at which to extract the cross-section,
+            The latitude interval (min_lat, max_lat) at which to extract the subset,
             in degrees. Values must be between -90.0 and 90.0
         inverse_indices : Union[List[str], Set[str], bool], optional
             Controls storage of original grid indices. Options:
@@ -298,12 +298,12 @@ def constant_longitude_interval(
         lons: Tuple[float, float],
         inverse_indices: Union[List[str], Set[str], bool] = False,
     ):
-        """Extracts a cross-section of data by selecting all faces are within a specifed longitude interval.
+        """Extracts a subset of data by selecting all faces are within a specifed longitude interval.
 
         Parameters
         ----------
         lons : Tuple[float, float]
-            The longitude interval (min_lon, max_lon) at which to extract the cross-section,
+            The longitude interval (min_lon, max_lon) at which to extract the subset,
             in degrees. Values must be between -180.0 and 180.0
         inverse_indices : Union[List[str], Set[str], bool], optional
             Controls storage of original grid indices. Options:

uxarray/subset/grid_accessor.py

@@ -144,13 +144,13 @@ def constant_latitude(
         return_face_indices: bool = False,
         inverse_indices: Union[List[str], Set[str], bool] = False,
     ):
-        """Extracts a cross-section of the grid by selecting all faces that
+        """Extracts a subset of the grid by selecting all faces that
         intersect with a specified line of constant latitude.
 
         Parameters
         ----------
         lon : float
-            The longitude at which to extract the cross-section, in degrees.
+            The longitude at which to extract the subset, in degrees.
             Must be between -90.0 and 90.0
         return_face_indices : bool, optional
             If True, also returns the indices of the faces that intersect with the
@@ -211,13 +211,13 @@ def constant_longitude(
         return_face_indices: bool = False,
         inverse_indices: Union[List[str], Set[str], bool] = False,
     ):
-        """Extracts a cross-section of the grid by selecting all faces that
+        """Extracts a subset of the grid by selecting all faces that
         intersect with a specified line of constant longitude.
 
         Parameters
         ----------
         lon : float
-            The longitude at which to extract the cross-section, in degrees.
+            The longitude at which to extract the subset, in degrees.
             Must be between -180.0 and 180.0
         return_face_indices : bool, optional
             If True, also returns the indices of the faces that intersect with the
@@ -277,13 +277,13 @@ def constant_latitude_interval(
         return_face_indices: bool = False,
         inverse_indices: Union[List[str], Set[str], bool] = False,
     ):
-        """Extracts a cross-section of the grid by selecting all faces that
+        """Extracts a subset of the grid by selecting all faces that
         are within a specified latitude interval.
 
         Parameters
         ----------
         lats : Tuple[float, float]
-            The latitude interval (min_lat, max_lat) at which to extract the cross-section,
+            The latitude interval (min_lat, max_lat) at which to extract the subset,
             in degrees. Values must be between -90.0 and 90.0
         return_face_indices : bool, optional
             If True, also returns the indices of the faces that intersect with the
@@ -339,12 +339,12 @@ def constant_longitude_interval(
         return_face_indices: bool = False,
         inverse_indices: Union[List[str], Set[str], bool] = False,
     ):
-        """Extracts a cross-section of the grid by selecting all faces are within a specifed longitude interval.
+        """Extracts a subset of the grid by selecting all faces are within a specifed longitude interval.
 
         Parameters
         ----------
         lons : Tuple[float, float]
-            The longitude interval (min_lon, max_lon) at which to extract the cross-section,
+            The longitude interval (min_lon, max_lon) at which to extract the subset,
             in degrees. Values must be between -180.0 and 180.0
         return_face_indices : bool, optional
             If True, also returns the indices of the faces that intersect are within a specifed longitude interval.