procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Better docstrings in seq.el and map.el

Browse source 
* lisp/emacs-lisp/map.el:
* lisp/emacs-lisp/seq.el: Improve the docstring for the pcase patterns.
This commit is contained in:
Nicolas Petton 2015-10-14 09:37:59 +02:00
parent e668176e7d
commit b5e2d74950
2 changed files with 15 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lisp/emacs-lisp/map.el
View file

@ -46,11 +46,15 @@
(pcase-defmacro map (&rest args)
"pcase pattern matching map elements.
Matches if the object is a map (list, hash-table or array), and
binds values from ARGS to their corresponding elements of the map.
ARGS can be a list elements of the form (KEY PAT), in which case
KEY in an unquoted form.
Matches if the object is a map (list, hash-table or array), and
each PATTERN matches the corresponding elements of the map.
Supernumerary elements of the map are ignore if less ARGS are
given, and the match does not fail.
ARGS can be a list of the form (KEY PAT), in which case KEY in an
unquoted form.
ARGS can also be a list of symbols, which stands for ('SYMBOL
SYMBOL)."

11
lisp/emacs-lisp/seq.el
View file

@ -71,13 +71,16 @@ Evaluate BODY with VAR bound to each element of SEQ, in turn.
,@body)
,(cadr spec)))
(pcase-defmacro seq (&rest args)
(pcase-defmacro seq (&rest patterns)
"pcase pattern matching sequence elements.
Matches if the object is a sequence (list, string or vector), and
binds each element of ARGS to the corresponding element of the
sequence."
each PATTERN matches the corresponding element of the sequence.
Supernumerary elements of the sequence are ignore if less
PATTERNS are given, and the match does not fail."
`(and (pred seq-p)
,@(seq--make-pcase-bindings args)))
,@(seq--make-pcase-bindings patterns)))
(defmacro seq-let (args seq &rest body)
"Bind the variables in ARGS to the elements of SEQ then evaluate BODY.