reformatted

Author: ZicsX

sorts/shrink_shell.py

@@ -1,29 +1,32 @@
 """
-This function implements the shell sort algorithm.
+This function implements the shell sort algorithm
+which is slightly faster than its pure implementation.
 
-Shell sort is a sorting algorithm that works by first sorting
-elements that are far apart from each other, and then sorting
-elements that are closer together. This reduces the amount of
-swapping that needs to be done, and makes the algorithm more
-efficient.
+This shell sort is implemented using a gap, which
+shrinks by a certain factor each iteration. In this
+implementation, the gap is initially set to the
+length of the collection. The gap is then reduced by
+a certain factor (1.3) each iteration.
 
-The algorithm works by first choosing a 'gap' value. This value
-determines how far apart the elements will be that are sorted
-first. The gap is then decreased, and the elements are sorted
-again. This process is repeated until the gap is 1, at which
-point the elements are sorted using insertion sort.
-
-Shell sort is an efficient algorithm that is easy to implement.
-It is a good choice for sorting large arrays of data.
+For each iteration, the algorithm compares elements
+that are a certain number of positions apart
+(determined by the gap). If the element at the higher
+position is greater than the element at the lower
+position, the two elements are swapped. The process
+is repeated until the gap is equal to 1.
 
+The reason this is more efficient is that it reduces
+the number of comparisons that need to be made. By
+using a smaller gap, the list is sorted more quickly.
 """
 
+
 def shell_sort(collection: list) -> list:
     """Implementation of shell sort algorithm in Python
     :param collection:  Some mutable ordered collection with heterogeneous
     comparable items inside
     :return:  the same collection ordered by ascending
-    
+
     >>> shell_sort([3, 2, 1])
     [1, 2, 3]
     >>> shell_sort([])
@@ -59,8 +62,5 @@ def shell_sort(collection: list) -> list:
 
 if __name__ == "__main__":
     import doctest
-    doctest.testmod()
 
-    user_input = input("Enter numbers separated by a comma:\n").strip()
-    collection = [int(item) for item in user_input.split(",")]
-    print(shell_sort(collection))
+    doctest.testmod()