add comments from doc, to describe how the locig works

Author: NewBornRustacean

src/impl_methods.rs

@@ -2549,37 +2549,6 @@ where
     /// **Panics** if any of the axes are out of bounds, if an axis is missing,
     /// or if an axis is repeated more than once.    
     ///
-    /// # About the Cycle Detection
-    ///
-    /// The cycle detection is done using a bitmask to track visited positions.
-    ///
-    /// For example, axes from \[0,1,2\] to \[2, 0, 1\]
-    /// For axis values \[1, 0, 2\]:
-    /// 1 << 1  // 0b0001 << 1 = 0b0010 (decimal 2)
-    /// 1 << 0  // 0b0001 << 0 = 0b0001 (decimal 1)
-    /// 1 << 2  // 0b0001 << 2 = 0b0100 (decimal 4)
-    ///
-    /// Each axis gets its own unique bit position in the bitmask:
-    /// - Axis 0: bit 0 (rightmost)
-    /// - Axis 1: bit 1
-    /// - Axis 2: bit 2
-    ///
-    /// The check `(visited & (1 << axis)) != 0` works as follows:
-    /// ```no_run
-    /// let mut visited = 0;  // 0b0000
-    /// let axis = 1;
-    /// let new_axis = 0;
-    /// // Check axis 1
-    /// if (visited & (1 << axis)) != 0 {  // 0b0000 & 0b0010 = 0b0000
-    ///     // Not visited yet
-    /// }
-    /// // Mark axis 1 as visited
-    /// visited |= (1 << axis) | (1 << new_axis);    // 0b0000 | 0b0010 | 0b0001 = 0b0011
-    /// if (visited & (1 << 1)) != 0 {  // 0b0011 & 0b0010 = 0b0010
-    ///     // Already visited!
-    /// }
-    /// ```
-    ///
     /// # Example
     /// ```rust
     /// use ndarray::{arr2, Array3};
@@ -2610,6 +2579,18 @@ where
         let strides = self.layout.strides.slice_mut();
         let axes = axes.slice();
 
+        // The cycle detection is done using a bitmask to track visited positions.
+        // For example, axes from [0,1,2] to [2, 0, 1]
+        // For axis values [1, 0, 2]:
+        // 1 << 1  // 0b0001 << 1 = 0b0010 (decimal 2)
+        // 1 << 0  // 0b0001 << 0 = 0b0001 (decimal 1)
+        // 1 << 2  // 0b0001 << 2 = 0b0100 (decimal 4)
+        //
+        // Each axis gets its own unique bit position in the bitmask:
+        // - Axis 0: bit 0 (rightmost)
+        // - Axis 1: bit 1
+        // - Axis 2: bit 2
+        //
         let mut visited = 0usize;
         for (new_axis, &axis) in axes.iter().enumerate() {
             if (visited & (1 << axis)) != 0 {