added doctests

Author: jenyyy4

data_structures/arrays/rotate_array.py

@@ -2,6 +2,27 @@
 
 
 def rotate_array(arr: List[int], k: int) -> List[int]:
+    """
+    Rotates a list to the right by k positions.
+
+    Parameters:
+    arr (List[int]): The list of integers to rotate.
+    k (int): Number of positions to rotate. Can be negative for left rotation.
+
+    Returns:
+    List[int]: Rotated list.
+
+    Examples:
+    >>> rotate_array([1, 2, 3, 4, 5], 2)
+    [4, 5, 1, 2, 3]
+    >>> rotate_array([1, 2, 3, 4, 5], -2)
+    [3, 4, 5, 1, 2]
+    >>> rotate_array([1, 2, 3, 4, 5], 7)
+    [4, 5, 1, 2, 3]
+    >>> rotate_array([], 3)
+    []
+    """
+
     n = len(arr)
     if n == 0:
         return arr
@@ -12,6 +33,31 @@ def rotate_array(arr: List[int], k: int) -> List[int]:
         k += n
 
     def reverse(start: int, end: int) -> None:
+        """
+        Reverses a portion of the list in place from index start to end.
+
+        Parameters:
+        start (int): Starting index of the portion to reverse.
+        end (int): Ending index of the portion to reverse.
+
+        Returns:
+        None
+
+        Examples:
+        >>> example = [1, 2, 3, 4, 5]
+        >>> def reverse_test(arr, start, end):
+        ...     while start < end:
+        ...         arr[start], arr[end] = arr[end], arr[start]
+        ...         start += 1
+        ...         end -= 1
+        >>> reverse_test(example, 0, 2)
+        >>> example
+        [3, 2, 1, 4, 5]
+        >>> reverse_test(example, 2, 4)
+        >>> example
+        [3, 2, 5, 4, 1]
+        """
+        
         while start < end:
             arr[start], arr[end] = arr[end], arr[start]
             start += 1