Update kaprekar_constant.py

Author: r4v3n-official

scripts/maths/kaprekar_constant.py

@@ -1,43 +1,39 @@
 def kaprekar_routine(number: int) -> int:
     """
-    Find steps to Kaprekar constant (6174) bro.
-    Link: https://wikipedia.org
+    Calculates the number of steps required to reach Kaprekar's constant (6174).
+    Link: https://en.wikipedia.org/wiki/6174
 
     >>> kaprekar_routine(3524)
     3
     >>> kaprekar_routine(6174)
     0
     """
 
-    # Checking if the number is 4 digits, throwing an error if not bro
+    # Ensure the input is a 4-digit positive integer
     if not (1000 <= number <= 9999):
-        raise ValueError("The number must be 4 digits bro!")
+        raise ValueError("The number must be a 4-digit integer.")
 
-    # If someone enters all same digits like 1111, loop breaks. Blocking it here
+    # Prevent repdigits (e.g., 1111) which result in zero and cause infinite loops
     if len(set(str(number))) < 2:
-        raise ValueError(
-            "Digits cannot be all the same bro, make at least two different!"
-        )
+        raise ValueError("The number must contain at least two distinct digits.")
 
     kaprekar_target = 6174
     steps = 0
 
-    # We are here until the number becomes 6174 bro, loop keeps spinning
+    # Iterate until the number reaches Kaprekar's constant
     while number != kaprekar_target:
-        # Padding the number to 4 digits and making it a string bro
+        # Zero-pad the number to ensure a 4-digit string representation
         digits = f"{number:04d}"
 
-        # Sorting digits from biggest to smallest and joining them
+        # Sort digits in descending and ascending order
         descending = int("".join(sorted(digits, reverse=True)))
-
-        # Sorting digits from smallest to biggest and joining them
         ascending = int("".join(sorted(digits)))
 
-        # Subtracting smallest from biggest, finding new number and increasing steps bro
+        # Subtract smaller number from larger number to get the next iteration
         number = descending - ascending
         steps += 1
 
-        # Infinite loop protection just in case we break something, spins 7 times max
+        # Safety check: Kaprekar's routine always reaches 6174 in at most 7 steps
         if steps > 7:
             break
 
@@ -47,8 +43,8 @@ def kaprekar_routine(number: int) -> int:
 if __name__ == "__main__":
     import doctest
 
-    # Running the test engine that the bots are checking
+    # Execute automated doctests
     doctest.testmod()
 
-    # Just a small example here to test it for myself
-    print(f"Our number locked in exactly {kaprekar_routine(3524)} steps bro!")
+    # Sample execution
+    print(f"Iterations required: {kaprekar_routine(3524)}")