hare

commit dca53a755ed2b76660a5ad2ac31a328dbd722776
parent 7be34d683820fe98a757a0af0380d3112c407198
Author: Alexey Yerin <yyp@disroot.org>
Date:   Wed,  6 Sep 2023 19:19:57 +0300

sort: Document that it provides a stable sort

Fixes: https://todo.sr.ht/~sircmpwn/hare/879
Signed-off-by: Alexey Yerin <yyp@disroot.org>

Diffstat:
M
sort/sort.ha
 | 
3
++-

1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/sort/sort.ha b/sort/sort.ha
@@ -2,7 +2,8 @@
 // (c) 2021 Drew DeVault <sir@cmpwn.com>
 // (c) 2021 Steven Guikal <void@fluix.one>
 
-// Sorts a slice of items in place.
+// Sorts a slice of items in place. This function provides a stable sort -
+// relative order of equal elements is preserved.
 //
 // Note that this function may (temporarily) allocate, and will abort on
 // allocation failure.