mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2024-11-28 11:09:54 +00:00
Code Issues 1 Releases Wiki Activity

sort doc

Browse Source 
Clarify doc for `sort` and `sorted`. Also in `sort`, changed arg name.
This commit is contained in:
John Gabriele 2021-02-23 22:24:59 -05:00 committed by GitHub
parent a5f237993d
commit 1f8c2781dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/boot/boot.janet
View File

@ -778,9 +778,12 @@
a)
(defn sort
"Sort an array in-place. Uses quick-sort and is not a stable sort."
[a &opt before?]
(sort-help a 0 (- (length a) 1) (or before? <)))
``Sort `ind` in-place, and return it. Uses quick-sort and is not a stable sort.
If a `before?` comparator function is provided, sorts elements using that;
otherwise uses `<`.``
[ind &opt before?]
(sort-help ind 0 (- (length ind) 1) (or before? <)))
(defn sort-by
``Returns `ind` sorted by calling
@ -789,7 +792,10 @@
(sort ind (fn [x y] (< (f x) (f y)))))
(defn sorted
"Returns a new sorted array without modifying the old one."
``Returns a new sorted array without modifying the old one.
If a `before?` comparator function is provided, sorts elements using that;
otherwise uses `<`.``
[ind &opt before?]
(sort (array/slice ind) before?))