From c5414bd312137579ae39c966b84b357bae46d4f1 Mon Sep 17 00:00:00 2001
From: Markus Fleschutz <markus.fleschutz@gmail.com>
Date: Mon, 21 Aug 2023 20:28:30 +0200
Subject: [PATCH] Update measure-HeapSort.ps1

---
 Scripts/measure-HeapSort.ps1 | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/Scripts/measure-HeapSort.ps1 b/Scripts/measure-HeapSort.ps1
index 09c391d2..db41ec85 100644
--- a/Scripts/measure-HeapSort.ps1
+++ b/Scripts/measure-HeapSort.ps1
@@ -1,4 +1,27 @@
-param([int]$numIntegers = 1000)
+<#
+.SYNOPSIS
+        Measures the speed of HeapSort
+.DESCRIPTION
+        This PowerShell script measures the speed of the HeapSort algorithm.
+        HeapSort is a comparison-based sorting algorithm. Heapsort can be thought of as an
+	improved selection sort: like selection sort, heapsort divides its input into a sorted
+	and an unsorted region, and it iteratively shrinks the unsorted region by extracting
+	the largest element from it and inserting it into the sorted region. Unlike selection
+	sort, heapsort does not waste time with a linear-time scan of the unsorted region;
+	rather, heap sort maintains the unsorted region in a heap data structure to more quickly
+	find the largest element in each step.
+.PARAMETER numIntegers
+        Specifies the number of integers to sort
+.EXAMPLE
+        PS> ./measure-HeapSort.ps1
+        🕒 HeapSort of 1000 integers took 0.6145732 sec
+.LINK
+        https://github.com/fleschutz/PowerShell
+.NOTES
+        Author: Markus Fleschutz | License: CC0
+#>
+
+param([int]$numIntegers = 1000)
 
 class HeapSort {
     static Sort($targetList) {