Add function documentation to CycleSort

charliejmoore · charliejmoore · commit 720b7b054bf1 · 2021-10-04T18:49:54.000-04:00
diff --git a/Sorts/CycleSort.js b/Sorts/CycleSort.js
@@ -8,6 +8,12 @@
  * Wikipedia: https://en.wikipedia.org/wiki/Cycle_sort
  */
 
+/**
+ * cycleSort takes an input array of numbers and returns the array sorted in increasing order.
+ *
+ * @param {number[]} list An array of numbers to be sorted.
+ * @return {number[]} An array of numbers sorted in increasing order.
+ */
 function cycleSort (list) {
   let writes = 0
   for (let cycleStart = 0; cycleStart < list.length; cycleStart++) {
