wilderjds
/
dash.el
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Prefer '() over () in printed examples

Browse Source 
* dev/examples.el (-take, -drop, -drop-last, -take-while)
(-running-sum, -running-product, -common-prefix, -common-suffix)
(-list, -each-indexed, -dotimes): Prefer '() over () in printed
examples, as we can control how the former is printed, whereas the
latter is always printed as nil.

* README.md:
* dash.texi: Regenerate docs.
master
Basil L. Contovounesios 5 years ago
parent 7048e6881f
commit 03748d885a
No known key found for this signature in database
GPG Key ID: 205AB54A5D5D8CFF
3 changed files with 35 additions and 35 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 22
      README.md
  2. 26
      dash.texi
  3. 22
      dev/examples.el

22
README.md
Unescape View File

@ -616,7 +616,7 @@ See also: [`-take-last`](#-take-last-n-list).
```el ```el
(-take 3 '(1 2 3 4 5)) ;; => '(1 2 3) (-take 3 '(1 2 3 4 5)) ;; => '(1 2 3)
(-take 17 '(1 2 3 4 5)) ;; => '(1 2 3 4 5) (-take 17 '(1 2 3 4 5)) ;; => '(1 2 3 4 5)
(-take 0 '(1 2 3 4 5)) ;; => nil (-take 0 '(1 2 3 4 5)) ;; => '()
``` ```
#### -take-last `(n list)` #### -take-last `(n list)`
@ -643,7 +643,7 @@ For another variant, see also [`-drop-last`](#-drop-last-n-list).
```el ```el
(-drop 3 '(1 2 3 4 5)) ;; => '(4 5) (-drop 3 '(1 2 3 4 5)) ;; => '(4 5)
(-drop 17 '(1 2 3 4 5)) ;; => nil (-drop 17 '(1 2 3 4 5)) ;; => '()
(-drop 0 '(1 2 3 4 5)) ;; => '(1 2 3 4 5) (-drop 0 '(1 2 3 4 5)) ;; => '(1 2 3 4 5)
``` ```
@ -657,7 +657,7 @@ See also: [`-drop`](#-drop-n-list).
```el ```el
(-drop-last 3 '(1 2 3 4 5)) ;; => '(1 2) (-drop-last 3 '(1 2 3 4 5)) ;; => '(1 2)
(-drop-last 17 '(1 2 3 4 5)) ;; => nil (-drop-last 17 '(1 2 3 4 5)) ;; => '()
(-drop-last 0 '(1 2 3 4 5)) ;; => '(1 2 3 4 5) (-drop-last 0 '(1 2 3 4 5)) ;; => '(1 2 3 4 5)
``` ```
@ -673,7 +673,7 @@ This function's anaphoric counterpart is `--take-while`.
For another variant, see also [`-drop-while`](#-drop-while-pred-list). For another variant, see also [`-drop-while`](#-drop-while-pred-list).
```el ```el
(-take-while #'even? '(1 2 3 4)) ;; => nil (-take-while #'even? '(1 2 3 4)) ;; => '()
(-take-while #'even? '(2 4 5 6)) ;; => '(2 4) (-take-while #'even? '(2 4 5 6)) ;; => '(2 4)
(--take-while (< it 4) '(1 2 3 4 3 2 1)) ;; => '(1 2 3) (--take-while (< it 4) '(1 2 3 4 3 2 1)) ;; => '(1 2 3)
``` ```
@ -1088,7 +1088,7 @@ Return a list with running sums of items in `list`.
```el ```el
(-running-sum '(1 2 3 4)) ;; => '(1 3 6 10) (-running-sum '(1 2 3 4)) ;; => '(1 3 6 10)
(-running-sum '(1)) ;; => '(1) (-running-sum '(1)) ;; => '(1)
(-running-sum nil) ;; Error (-running-sum '()) ;; Error
``` ```
#### -product `(list)` #### -product `(list)`
@ -1109,7 +1109,7 @@ Return a list with running products of items in `list`.
```el ```el
(-running-product '(1 2 3 4)) ;; => '(1 2 6 24) (-running-product '(1 2 3 4)) ;; => '(1 2 6 24)
(-running-product '(1)) ;; => '(1) (-running-product '(1)) ;; => '(1)
(-running-product nil) ;; Error (-running-product '()) ;; Error
``` ```
#### -inits `(list)` #### -inits `(list)`
@ -1138,7 +1138,7 @@ Return the longest common prefix of `lists`.
```el ```el
(-common-prefix '(1)) ;; => '(1) (-common-prefix '(1)) ;; => '(1)
(-common-prefix '(1 2) '(3 4) '(1 2)) ;; => nil (-common-prefix '(1 2) '(3 4) '(1 2)) ;; => '()
(-common-prefix '(1 2) '(1 2 3) '(1 2 3 4)) ;; => '(1 2) (-common-prefix '(1 2) '(1 2 3) '(1 2 3 4)) ;; => '(1 2)
``` ```
@ -1148,7 +1148,7 @@ Return the longest common suffix of `lists`.
```el ```el
(-common-suffix '(1)) ;; => '(1) (-common-suffix '(1)) ;; => '(1)
(-common-suffix '(1 2) '(3 4) '(1 2)) ;; => nil (-common-suffix '(1 2) '(3 4) '(1 2)) ;; => '()
(-common-suffix '(1 2 3 4) '(2 3 4) '(3 4)) ;; => '(3 4) (-common-suffix '(1 2 3 4) '(2 3 4) '(3 4)) ;; => '(3 4)
``` ```
@ -2106,7 +2106,7 @@ backward compatibility and is otherwise deprecated.
```el ```el
(-list 1) ;; => '(1) (-list 1) ;; => '(1)
(-list nil) ;; => nil (-list '()) ;; => '()
(-list '(1 2 3)) ;; => '(1 2 3) (-list '(1 2 3)) ;; => '(1 2 3)
``` ```
@ -2692,7 +2692,7 @@ See also: [`-map-indexed`](#-map-indexed-fn-list).
```el ```el
(let (l) (-each-indexed '(a b c) (lambda (i x) (push (list x i) l))) l) ;; => '((c 2) (b 1) (a 0)) (let (l) (-each-indexed '(a b c) (lambda (i x) (push (list x i) l))) l) ;; => '((c 2) (b 1) (a 0))
(let (l) (--each-indexed '(a b c) (push (list it it-index) l)) l) ;; => '((c 2) (b 1) (a 0)) (let (l) (--each-indexed '(a b c) (push (list it it-index) l)) l) ;; => '((c 2) (b 1) (a 0))
(let (l) (--each-indexed nil (push it l)) l) ;; => nil (let (l) (--each-indexed '() (push it l)) l) ;; => '()
``` ```
#### -each-r `(list fn)` #### -each-r `(list fn)`
@ -2734,7 +2734,7 @@ This function's anaphoric counterpart is `--dotimes`.
```el ```el
(let (s) (-dotimes 3 (lambda (n) (push n s))) s) ;; => '(2 1 0) (let (s) (-dotimes 3 (lambda (n) (push n s))) s) ;; => '(2 1 0)
(let (s) (-dotimes 0 (lambda (n) (push n s))) s) ;; => nil (let (s) (-dotimes 0 (lambda (n) (push n s))) s) ;; => '()
(let (s) (--dotimes 5 (push it s)) s) ;; => '(4 3 2 1 0) (let (s) (--dotimes 5 (push it s)) s) ;; => '(4 3 2 1 0)
``` ```

26
dash.texi
Unescape View File

@ -673,7 +673,7 @@ See also: @code{-take-last} (@pxref{-take-last}).
@end group @end group
@group @group
(-take 0 '(1 2 3 4 5)) (-take 0 '(1 2 3 4 5))
@result{} nil @result{} '()
@end group @end group
@end example @end example
@end defun @end defun
@ -717,7 +717,7 @@ For another variant, see also @code{-drop-last} (@pxref{-drop-last}).
@end group @end group
@group @group
(-drop 17 '(1 2 3 4 5)) (-drop 17 '(1 2 3 4 5))
@result{} nil @result{} '()
@end group @end group
@group @group
(-drop 0 '(1 2 3 4 5)) (-drop 0 '(1 2 3 4 5))
@ -741,7 +741,7 @@ See also: @code{-drop} (@pxref{-drop}).
@end group @end group
@group @group
(-drop-last 17 '(1 2 3 4 5)) (-drop-last 17 '(1 2 3 4 5))
@result{} nil @result{} '()
@end group @end group
@group @group
(-drop-last 0 '(1 2 3 4 5)) (-drop-last 0 '(1 2 3 4 5))
@ -764,7 +764,7 @@ For another variant, see also @code{-drop-while} (@pxref{-drop-while}).
@example @example
@group @group
(-take-while #'even? '(1 2 3 4)) (-take-while #'even? '(1 2 3 4))
@result{} nil @result{} '()
@end group @end group
@group @group
(-take-while #'even? '(2 4 5 6)) (-take-while #'even? '(2 4 5 6))
@ -1444,7 +1444,7 @@ Return a list with running sums of items in @var{list}.
@result{} '(1) @result{} '(1)
@end group @end group
@group @group
(-running-sum nil) (-running-sum '())
@error{} "Wrong type argument: consp, nil" @error{} "Wrong type argument: consp, nil"
@end group @end group
@end example @end example
@ -1485,7 +1485,7 @@ Return a list with running products of items in @var{list}.
@result{} '(1) @result{} '(1)
@end group @end group
@group @group
(-running-product nil) (-running-product '())
@error{} "Wrong type argument: consp, nil" @error{} "Wrong type argument: consp, nil"
@end group @end group
@end example @end example
@ -1542,7 +1542,7 @@ Return the longest common prefix of @var{lists}.
@end group @end group
@group @group
(-common-prefix '(1 2) '(3 4) '(1 2)) (-common-prefix '(1 2) '(3 4) '(1 2))
@result{} nil @result{} '()
@end group @end group
@group @group
(-common-prefix '(1 2) '(1 2 3) '(1 2 3 4)) (-common-prefix '(1 2) '(1 2 3) '(1 2 3 4))
@ -1562,7 +1562,7 @@ Return the longest common suffix of @var{lists}.
@end group @end group
@group @group
(-common-suffix '(1 2) '(3 4) '(1 2)) (-common-suffix '(1 2) '(3 4) '(1 2))
@result{} nil @result{} '()
@end group @end group
@group @group
(-common-suffix '(1 2 3 4) '(2 3 4) '(3 4)) (-common-suffix '(1 2 3 4) '(2 3 4) '(3 4))
@ -3228,8 +3228,8 @@ backward compatibility and is otherwise deprecated.
@result{} '(1) @result{} '(1)
@end group @end group
@group @group
(-list nil) (-list '())
@result{} nil @result{} '()
@end group @end group
@group @group
(-list '(1 2 3)) (-list '(1 2 3))
@ -4083,8 +4083,8 @@ See also: @code{-map-indexed} (@pxref{-map-indexed}).
@result{} '((c 2) (b 1) (a 0)) @result{} '((c 2) (b 1) (a 0))
@end group @end group
@group @group
(let (l) (--each-indexed nil (push it l)) l) (let (l) (--each-indexed '() (push it l)) l)
@result{} nil @result{} '()
@end group @end group
@end example @end example
@end defun @end defun
@ -4153,7 +4153,7 @@ This function's anaphoric counterpart is @code{--dotimes}.
@end group @end group
@group @group
(let (s) (-dotimes 0 (lambda (n) (push n s))) s) (let (s) (-dotimes 0 (lambda (n) (push n s))) s)
@result{} nil @result{} '()
@end group @end group
@group @group
(let (s) (--dotimes 5 (push it s)) s) (let (s) (--dotimes 5 (push it s)) s)

22
dev/examples.el
Unescape View File

@ -244,7 +244,7 @@ new list."
(defexamples -take (defexamples -take
(-take 3 '(1 2 3 4 5)) => '(1 2 3) (-take 3 '(1 2 3 4 5)) => '(1 2 3)
(-take 17 '(1 2 3 4 5)) => '(1 2 3 4 5) (-take 17 '(1 2 3 4 5)) => '(1 2 3 4 5)
(-take 0 '(1 2 3 4 5)) => () (-take 0 '(1 2 3 4 5)) => '()
(-take 0 ()) => () (-take 0 ()) => ()
(-take -1 ()) => () (-take -1 ()) => ()
(-take -1 '(1)) => () (-take -1 '(1)) => ()
@ -264,7 +264,7 @@ new list."
(defexamples -drop (defexamples -drop
(-drop 3 '(1 2 3 4 5)) => '(4 5) (-drop 3 '(1 2 3 4 5)) => '(4 5)
(-drop 17 '(1 2 3 4 5)) => () (-drop 17 '(1 2 3 4 5)) => '()
(-drop 0 '(1 2 3 4 5)) => '(1 2 3 4 5) (-drop 0 '(1 2 3 4 5)) => '(1 2 3 4 5)
(-drop 0 ()) => () (-drop 0 ()) => ()
(-drop -1 ()) => () (-drop -1 ()) => ()
@ -275,7 +275,7 @@ new list."
(defexamples -drop-last (defexamples -drop-last
(-drop-last 3 '(1 2 3 4 5)) => '(1 2) (-drop-last 3 '(1 2 3 4 5)) => '(1 2)
(-drop-last 17 '(1 2 3 4 5)) => () (-drop-last 17 '(1 2 3 4 5)) => '()
(-drop-last 0 '(1 2 3 4 5)) => '(1 2 3 4 5) (-drop-last 0 '(1 2 3 4 5)) => '(1 2 3 4 5)
(-drop-last 0 ()) => () (-drop-last 0 ()) => ()
(-drop-last -1 ()) => () (-drop-last -1 ()) => ()
@ -285,7 +285,7 @@ new list."
(let ((l (list 1 2))) (eq (-drop-last 0 l) l)) => nil) (let ((l (list 1 2))) (eq (-drop-last 0 l) l)) => nil)
(defexamples -take-while (defexamples -take-while
(-take-while #'even? '(1 2 3 4)) => () (-take-while #'even? '(1 2 3 4)) => '()
(-take-while #'even? '(2 4 5 6)) => '(2 4) (-take-while #'even? '(2 4 5 6)) => '(2 4)
(--take-while (< it 4) '(1 2 3 4 3 2 1)) => '(1 2 3) (--take-while (< it 4) '(1 2 3 4 3 2 1)) => '(1 2 3)
(--take-while t ()) => () (--take-while t ()) => ()
@ -536,7 +536,7 @@ new list."
(defexamples -running-sum (defexamples -running-sum
(-running-sum '(1 2 3 4)) => '(1 3 6 10) (-running-sum '(1 2 3 4)) => '(1 3 6 10)
(-running-sum '(1)) => '(1) (-running-sum '(1)) => '(1)
(-running-sum ()) !!> (wrong-type-argument consp ())) (-running-sum '()) !!> (wrong-type-argument consp ()))
(defexamples -product (defexamples -product
(-product '()) => 1 (-product '()) => 1
@ -546,7 +546,7 @@ new list."
(defexamples -running-product (defexamples -running-product
(-running-product '(1 2 3 4)) => '(1 2 6 24) (-running-product '(1 2 3 4)) => '(1 2 6 24)
(-running-product '(1)) => '(1) (-running-product '(1)) => '(1)
(-running-product ()) !!> (wrong-type-argument consp ())) (-running-product '()) !!> (wrong-type-argument consp ()))
(defexamples -inits (defexamples -inits
(-inits '(1 2 3 4)) => '(nil (1) (1 2) (1 2 3) (1 2 3 4)) (-inits '(1 2 3 4)) => '(nil (1) (1 2) (1 2 3) (1 2 3 4))
@ -560,7 +560,7 @@ new list."
(defexamples -common-prefix (defexamples -common-prefix
(-common-prefix '(1)) => '(1) (-common-prefix '(1)) => '(1)
(-common-prefix '(1 2) '(3 4) '(1 2)) => () (-common-prefix '(1 2) '(3 4) '(1 2)) => '()
(-common-prefix '(1 2) '(1 2 3) '(1 2 3 4)) => '(1 2) (-common-prefix '(1 2) '(1 2 3) '(1 2 3 4)) => '(1 2)
(-common-prefix () '(1 2) '(1 2)) => () (-common-prefix () '(1 2) '(1 2)) => ()
(-common-prefix '(1 2) '(1 2) ()) => () (-common-prefix '(1 2) '(1 2) ()) => ()
@ -572,7 +572,7 @@ new list."
(defexamples -common-suffix (defexamples -common-suffix
(-common-suffix '(1)) => '(1) (-common-suffix '(1)) => '(1)
(-common-suffix '(1 2) '(3 4) '(1 2)) => () (-common-suffix '(1 2) '(3 4) '(1 2)) => '()
(-common-suffix '(1 2 3 4) '(2 3 4) '(3 4)) => '(3 4) (-common-suffix '(1 2 3 4) '(2 3 4) '(3 4)) => '(3 4)
(-common-suffix () '(1 2) '(1 2)) => () (-common-suffix () '(1 2) '(1 2)) => ()
(-common-suffix '(1 2) '(1 2) ()) => () (-common-suffix '(1 2) '(1 2) ()) => ()
@ -1130,7 +1130,7 @@ value rather than consuming a list to produce a single value."
(defexamples -list (defexamples -list
(-list 1) => '(1) (-list 1) => '(1)
(-list ()) => () (-list '()) => '()
(-list '(1 2 3)) => '(1 2 3) (-list '(1 2 3)) => '(1 2 3)
(-list 1 2 3) => '(1 2 3) (-list 1 2 3) => '(1 2 3)
(let ((l (list 1 2))) (setcar (-list l) 3) l) => '(3 2) (let ((l (list 1 2))) (setcar (-list l) 3) l) => '(3 2)
@ -1583,7 +1583,7 @@ value rather than consuming a list to produce a single value."
(defexamples -each-indexed (defexamples -each-indexed
(let (l) (-each-indexed '(a b c) (lambda (i x) (push (list x i) l))) l) => '((c 2) (b 1) (a 0)) (let (l) (-each-indexed '(a b c) (lambda (i x) (push (list x i) l))) l) => '((c 2) (b 1) (a 0))
(let (l) (--each-indexed '(a b c) (push (list it it-index) l)) l) => '((c 2) (b 1) (a 0)) (let (l) (--each-indexed '(a b c) (push (list it it-index) l)) l) => '((c 2) (b 1) (a 0))
(let (l) (--each-indexed () (push it l)) l) => () (let (l) (--each-indexed '() (push it l)) l) => '()
(let (l) (-each-indexed () (lambda (_ x) (push x l))) l) => ()) (let (l) (-each-indexed () (lambda (_ x) (push x l))) l) => ())
(defexamples -each-r (defexamples -each-r
@ -1609,7 +1609,7 @@ value rather than consuming a list to produce a single value."
(defexamples -dotimes (defexamples -dotimes
(let (s) (-dotimes 3 (lambda (n) (push n s))) s) => '(2 1 0) (let (s) (-dotimes 3 (lambda (n) (push n s))) s) => '(2 1 0)
(let (s) (-dotimes 0 (lambda (n) (push n s))) s) => () (let (s) (-dotimes 0 (lambda (n) (push n s))) s) => '()
(let (s) (--dotimes 5 (push it s)) s) => '(4 3 2 1 0) (let (s) (--dotimes 5 (push it s)) s) => '(4 3 2 1 0)
(let (s) (--dotimes 0 (push it s)) s) => () (let (s) (--dotimes 0 (push it s)) s) => ()
(let (s) (--dotimes 3 (push it s) (setq it -1)) s) => '(2 1 0) (let (s) (--dotimes 3 (push it s) (setq it -1)) s) => '(2 1 0)

Write Preview
Loading…
Cancel
Save