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

Merge pull request #1046 from dressupgeekout/charlotte_sort_doc

Browse Source 
Explicitly mention that `sort-by` sorts a list in place.
This commit is contained in:
Calvin Rose 2022-12-16 11:11:07 -06:00 committed by GitHub
commit 57e6ee963d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/boot/boot.janet
View File

@ -839,15 +839,15 @@
a) a)
(defn sort (defn sort
``Sort `ind` in-place, and return it. Uses quick-sort and is not a stable sort. ``Sorts `ind` in-place, and returns it. Uses quick-sort and is not a stable sort.
If a `before?` comparator function is provided, sorts elements using that, If a `before?` comparator function is provided, sorts elements using that,
otherwise uses `<`.`` otherwise uses `<`.``
[ind &opt before?] [ind &opt before?]
(sort-help ind 0 (- (length ind) 1) (or before? <))) (sort-help ind 0 (- (length ind) 1) (or before? <)))
(defn sort-by (defn sort-by
``Returns `ind` sorted by calling ``Sorts `ind` in-place by calling a function `f` on each element and
a function `f` on each element and comparing the result with `<`.`` comparing the result with `<`.``
[f ind] [f ind]
(sort ind (fn [x y] (< (f x) (f y))))) (sort ind (fn [x y] (< (f x) (f y)))))