add description of cyclical_axis argument

yoyolicoris · May 28, 2024 · 93389ab · 93389ab
1 parent f26d78b
commit 93389ab
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/kamui/__init__.py b/kamui/__init__.py
@@ -42,6 +42,9 @@ def unwrap_dimensional(
     use_edgelist : bool
         Whether to use the edgelist method.
         Default to False.
+    cyclical_axis : int or (int, int)
+        The axis that is cyclical.
+        Default to ().
     kwargs : dict
         Other arguments passed to `kamui.unwrap_arbitrary`.