1
0
mirror of https://github.com/janet-lang/janet synced 2024-12-29 01:40:26 +00:00

boot.janet, compare*, light formatting

Since those represent code, they should get backticks.
This commit is contained in:
John Gabriele 2020-11-28 14:41:42 -05:00 committed by GitHub
parent 7c8f5ef811
commit 53400ecac1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -731,11 +731,11 @@
## Polymorphic comparisons
(defn compare
`Polymorphic compare. Returns -1, 0, 1 for x < y, x = y, x > y respectively.
``Polymorphic compare. Returns -1, 0, 1 for x < y, x = y, x > y respectively.
Differs from the primitive comparators in that it first checks to
see whether either x or y implement a 'compare' method which can
compare x and y. If so it uses that compare method. If not, it
delegates to the primitive comparators.`
see whether either x or y implement a `compare` method which can
compare x and y. If so, it uses that compare method. If not, it
delegates to the primitive comparators.``
[x y]
(or
(when-let [f (get x :compare)] (f x y))
@ -753,27 +753,27 @@
r)
(defn compare=
"Equivalent of '=' but using compare function instead of primitive comparator"
``Equivalent of `=` but using compare function instead of primitive comparator.``
[& xs]
(compare-reduce = xs))
(defn compare<
"Equivalent of '<' but using compare function instead of primitive comparator"
``Equivalent of `<` but using compare function instead of primitive comparator.``
[& xs]
(compare-reduce < xs))
(defn compare<=
"Equivalent of '<=' but using compare function instead of primitive comparator"
``Equivalent of `<=` but using compare function instead of primitive comparator.``
[& xs]
(compare-reduce <= xs))
(defn compare>
"Equivalent of '>' but using compare function instead of primitive comparator"
``Equivalent of `>` but using compare function instead of primitive comparator.``
[& xs]
(compare-reduce > xs))
(defn compare>=
"Equivalent of '>=' but using compare function instead of primitive comparator"
``Equivalent of `>=` but using compare function instead of primitive comparator.``
[& xs]
(compare-reduce >= xs))