Update src/eddymotion/utils.py

Co-authored-by: Oscar Esteban <[email protected]>
nipreps · Apr 5, 2024 · 69611fa · 69611fa
1 parent 3d7afb1
commit 69611fa
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/eddymotion/utils.py b/src/eddymotion/utils.py
@@ -127,6 +127,13 @@ def centralsym_action(size, **kwargs):
         Number of volumes in the dataset
         (for instance, the number of orientations in a DWI)
 
+    Examples
+    --------
+    >>> centralsym_action(10)
+    [4, 5, 3, 6, 2, 7, 1, 8, 0, 9]
+    >>> centralsym_action(11)
+    [4, 5, 3, 6, 2, 7, 1, 8, 0, 9, 10]
+
     Returns
     -------
     :obj:`list` of :obj:`int`