summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Heerdegen <michael_heerdegen@web.de>2015-11-03 23:42:24 +0100
committerMichael Heerdegen <michael_heerdegen@web.de>2015-11-03 23:59:42 +0100
commit335cb1ee158db47003bda61a6cb077b62d04ca4f (patch)
treed4b9184b5c02236f9eb32df62deab5d20cd69aba
parent5d1e2fec21dee5d7f81c774e3e30ce8c0c8e5176 (diff)
* lisp/emacs-lisp/pcase.el (pcase): Tweak docstring.
-rw-r--r--lisp/emacs-lisp/pcase.el8
1 files changed, 4 insertions, 4 deletions
diff --git a/lisp/emacs-lisp/pcase.el b/lisp/emacs-lisp/pcase.el
index 8bcb447cfb..bf6550dfa3 100644
--- a/lisp/emacs-lisp/pcase.el
+++ b/lisp/emacs-lisp/pcase.el
@@ -107,7 +107,7 @@
;;;###autoload
(defmacro pcase (exp &rest cases)
- "Perform ML-style pattern matching on EXP.
+ "Eval EXP and perform ML-style pattern matching on that value.
CASES is a list of elements of the form (PATTERN CODE...).
Patterns can take the following forms:
@@ -115,7 +115,7 @@ Patterns can take the following forms:
SYMBOL matches anything and binds it to SYMBOL.
(or PAT...) matches if any of the patterns matches.
(and PAT...) matches if all the patterns match.
- \\='VAL matches if the object is `equal' to VAL
+ \\='VAL matches if the object is `equal' to VAL.
ATOM is a shorthand for \\='ATOM.
ATOM can be a keyword, an integer, or a string.
(pred FUN) matches if FUN applied to the object returns non-nil.
@@ -131,11 +131,11 @@ FUN can take the form
which is the value being matched.
So a FUN of the form SYMBOL is equivalent to one of the form (FUN).
FUN can refer to variables bound earlier in the pattern.
-FUN is assumed to be pure, i.e. it can be dropped if its result is not used,
-and two identical calls can be merged into one.
E.g. you can match pairs where the cdr is larger than the car with a pattern
like \\=`(,a . ,(pred (< a))) or, with more checks:
\\=`(,(and a (pred numberp)) . ,(and (pred numberp) (pred (< a))))
+FUN is assumed to be pure, i.e. it can be dropped if its result is not used,
+and two identical calls can be merged into one.
Additional patterns can be defined via `pcase-defmacro'.
Currently, the following patterns are provided this way:"