💬 Update type hints

arafune · Feb 26, 2024 · 0382ed0 · 0382ed0
1 parent 5b3710c
commit 0382ed0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/src/arpes/utilities/conversion/core.py b/src/arpes/utilities/conversion/core.py
@@ -107,7 +107,7 @@ def grid_interpolator_from_dataarray(
 
 def slice_along_path(  # noqa: PLR0913
     arr: xr.DataArray,
-    interpolation_points: NDArray[np.float_] | None = None,
+    interpolation_points: NDArray[np.float_],
     axis_name: str = "",
     resolution: float = 0,
     n_points: int | None = None,
@@ -383,7 +383,7 @@ def convert_to_kspace(  # noqa: PLR0913
         ValueError: [description]
 
     Returns:
-        [type]: [description]
+        xr.DataArray: [description]
     """
     if coords is None:
         coords = {}

diff --git a/src/arpes/xarray_extensions.py b/src/arpes/xarray_extensions.py
@@ -189,9 +189,14 @@ def along(
         directions: NDArray[np.float_],
         **kwargs: Unpack[_SliceAlongPathKwags],
     ) -> xr.Dataset:
-        """TODO: Need description.
+        """[TODO:summary].
 
-        ToDo: Test
+        Args:
+            directions (NDArray[np.float_]): [TODO:description]
+            kwargs: axis_name, resolution, n_points, extend_to_edge_shift_gamma
+
+        Returns:
+            xr.Dataset
         """
         assert isinstance(self._obj, xr.DataArray)
         return slice_along_path(self._obj, interpolation_points=directions, **kwargs)