[#914] _core_optics: add comment for split() routine

ToFuProject · Mar 1, 2024 · 93f25f1 · 93f25f1
1 parent 6876dbd
commit 93f25f1
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/tofu/geom/_core_optics.py b/tofu/geom/_core_optics.py
@@ -1151,6 +1151,13 @@ def get_rays_from_cryst(
     # -----------------
 
     def split(self, direction=None, nb=None):
+        """
+        Use to split the crystal in the direction wanted for nb pieces wanted.
+        If direction = 'e1', the crystal is splitted in the vertical way,
+        i.e. nb wide vertical crystals.
+        If direction = 'e2', the crystal is splitted in the horizontal way,
+        i.e. nb wide horizontal crystals.
+        """
 
         # ------------
         # check inputs