doc: unify docstring style

yoyolicoris · Apr 2, 2024 · 64fb16d · 64fb16d
1 parent 5ea1b10
commit 64fb16d
Showing 1 changed file with 20 additions and 10 deletions.
diff --git a/kamui/utils.py b/kamui/utils.py
@@ -10,12 +10,17 @@ def get_2d_edges_and_simplices(
     """
     Compute the edges and simplices for a 2D grid.
 
-    Args:
-        shape (Tuple[int, int]): The shape of the grid.
-        cyclical_axis (Union[int, Tuple[int, int]], optional): The axis/axes that should be treated as cyclical. Defaults to ().
+    Parameters
+    ----------
+    shape : Tuple[int, int]
+        The shape of the grid.
+    cyclical_axis : Union[int, Tuple[int, int]], optional
+        The axis/axes that should be treated as cyclical. Defaults to ().
 
-    Returns:
-        Tuple[np.ndarray, Iterable[Iterable[int]]]: A tuple containing the edges and simplices of the grid.
+    Returns
+    -------
+    Tuple[np.ndarray, Iterable[Iterable[int]]]
+        A tuple containing the edges and simplices of the grid.
     """
     nodes = np.arange(np.prod(shape)).reshape(shape)
     if type(cyclical_axis) is int:
@@ -83,12 +88,17 @@ def get_3d_edges_and_simplices(
     """
     Compute the edges and simplices for a 3D grid.
 
-    Args:
-        shape (Tuple[int, int, int]): The shape of the grid.
-        cyclical_axis (Union[int, Tuple[int, int]], optional): The axis/axes that should be treated as cyclical. Defaults to ().
+    Parameters
+    ----------
+    shape : Tuple[int, int, int]
+        The shape of the grid.
+    cyclical_axis : Union[int, Tuple[int, int]], optional
+        The axis/axes that should be treated as cyclical. Defaults to ().
 
-    Returns:
-        Tuple[np.ndarray, Iterable[Iterable[int]]]: A tuple containing the edges and simplices of the grid.
+    Returns
+    -------
+    Tuple[np.ndarray, Iterable[Iterable[int]]]
+        A tuple containing the edges and simplices of the grid.
     """
     nodes = np.arange(np.prod(shape)).reshape(shape)
     if type(cyclical_axis) is int: