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

Update documentation.

Browse Source
master
Matus Goljer 11 years ago
parent 5d2a73c0b3
commit ffe72fbee0
2 changed files with 100 additions and 13 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 26
      README.md
  2. 87
      dash.texi

26
README.md
Unescape View File

@ -598,6 +598,14 @@ Return a new list with the concatenation of the elements in the supplied `lists`
Take a nested list `l` and return its contents as a single, flat list.
Note that because `nil` represents a list of zero elements (an
empty list), any mention of nil in `l` will disappear after
flattening. If you need to preserve nils, consider [`-flatten-n`](#-flatten-n-num-list)
or map them to some unique symbol and then map them back.
Conses of two atoms are considered "terminals", that is, they
aren't flattened further.
See also: [`-flatten-n`](#-flatten-n-num-list)
```el
@ -1787,7 +1795,7 @@ and when that result is non-nil, through the next form, etc.
```el
(-some-> '(2 3 5)) ;; => '(2 3 5)
(-some-> 5 square) ;; => 25
(-some-> nil square) ;; => nil
(-some-> 5 even? square) ;; => nil
```
#### -some->> `(x &optional form &rest more)`
@ -1837,7 +1845,9 @@ If all `vals` evaluate to true, bind them to their corresponding
`vars` and execute body. `vars-vals` should be a list of (`var` `val`)
pairs.
Note: binding is done according to [`-let*`](#-let-varlist-rest-body).
Note: binding is done according to [`-let*`](#-let-varlist-rest-body). `vals` are evaluated
sequentially, and evaluation stops after the first nil `val` is
encountered.
```el
(-when-let* ((x 5) (y 3) (z (+ y 4))) (+ x y z)) ;; => 15
@ -1862,7 +1872,9 @@ If all `vals` evaluate to true, bind them to their corresponding
`vars` and do `then`, otherwise do `else`. `vars-vals` should be a list
of (`var` `val`) pairs.
Note: binding is done according to [`-let*`](#-let-varlist-rest-body).
Note: binding is done according to [`-let*`](#-let-varlist-rest-body). `vals` are evaluated
sequentially, and evaluation stops after the first nil `val` is
encountered.
```el
(-if-let* ((x 5) (y 3) (z 7)) (+ x y z) "foo") ;; => 15
@ -1932,10 +1944,10 @@ Vectors:
If the `pattern` is longer than `source`, an `error` is
thrown.
[a1 a2 a3 ... &rest rest] ) - as above, but bind the rest of
the sequence to `rest`. This is
conceptually the same as improper list
matching (a1 a2 ... aN . rest)
[a1 a2 a3 ... &rest rest] - as above, but bind the rest of
the sequence to `rest`. This is
conceptually the same as improper list
matching (a1 a2 ... aN . rest)
Key/value stores:

87
dash.texi
Unescape View File

@ -727,6 +727,14 @@ Return a new list with the concatenation of the elements in the supplied @var{li
@defun -flatten (l)
Take a nested list @var{l} and return its contents as a single, flat list.
Note that because @code{nil} represents a list of zero elements (an
empty list), any mention of nil in @var{l} will disappear after
flattening. If you need to preserve nils, consider @code{-flatten-n} (@pxref{-flatten-n})
or map them to some unique symbol and then map them back.
Conses of two atoms are considered "terminals", that is, they
aren't flattened further.
See also: @code{-flatten-n} (@pxref{-flatten-n})
@example
@ -2759,6 +2767,69 @@ in second form, etc.
@end example
@end defun
@anchor{-some->}
@defun -some-> (x &optional form &rest more)
When expr is non-nil, thread it through the first form (via @code{->} (@pxref{->})),
and when that result is non-nil, through the next form, etc.
@example
@group
(-some-> '(2 3 5))
@result{} '(2 3 5)
@end group
@group
(-some-> 5 square)
@result{} 25
@end group
@group
(-some-> 5 even? square)
@result{} nil
@end group
@end example
@end defun
@anchor{-some->>}
@defun -some->> (x &optional form &rest more)
When expr is non-nil, thread it through the first form (via @code{->>} (@pxref{->>})),
and when that result is non-nil, through the next form, etc.
@example
@group
(-some->> '(1 2 3) (-map 'square))
@result{} '(1 4 9)
@end group
@group
(-some->> '(1 3 5) (-last 'even?) (+ 100))
@result{} nil
@end group
@group
(-some->> '(2 4 6) (-last 'even?) (+ 100))
@result{} 106
@end group
@end example
@end defun
@anchor{-some-->}
@defun -some--> (x &optional form &rest more)
When expr in non-nil, thread it through the first form (via @code{-->} (@pxref{-->})),
and when that result is non-nil, through the next form, etc.
@example
@group
(-some--> "def" (concat "abc" it "ghi"))
@result{} "abcdefghi"
@end group
@group
(-some--> nil (concat "abc" it "ghi"))
@result{} nil
@end group
@group
(-some--> '(1 3 5) (-filter 'even? it) (append it it) (-map 'square it))
@result{} nil
@end group
@end example
@end defun
@node Binding
@section Binding
@ -2796,7 +2867,9 @@ If all @var{vals} evaluate to true, bind them to their corresponding
@var{vars} and execute body. @var{vars-vals} should be a list of (@var{var} @var{val})
pairs.
Note: binding is done according to @code{-let*} (@pxref{-let*}).
Note: binding is done according to @code{-let*} (@pxref{-let*}). @var{vals} are evaluated
sequentially, and evaluation stops after the first nil @var{val} is
encountered.
@example
@group
@ -2835,7 +2908,9 @@ If all @var{vals} evaluate to true, bind them to their corresponding
@var{vars} and do @var{then}, otherwise do @var{else}. @var{vars-vals} should be a list
of (@var{var} @var{val}) pairs.
Note: binding is done according to @code{-let*} (@pxref{-let*}).
Note: binding is done according to @code{-let*} (@pxref{-let*}). @var{vals} are evaluated
sequentially, and evaluation stops after the first nil @var{val} is
encountered.
@example
@group
@ -2915,10 +2990,10 @@ Vectors:
If the @var{pattern} is longer than @var{source}, an @code{error} is
thrown.
[a1 a2 a3 ... &rest rest] ) - as above, but bind the rest of
the sequence to @var{rest}. This is
conceptually the same as improper list
matching (a1 a2 ... aN . rest)
[a1 a2 a3 ... &rest rest] - as above, but bind the rest of
the sequence to @var{rest}. This is
conceptually the same as improper list
matching (a1 a2 ... aN . rest)
Key/value stores:

Write Preview
Loading…
Cancel
Save