mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
Code Issues Projects Releases Wiki Activity

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
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)."