]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify that nil doesn't match itself as a cl-case clause (Bug#30749)
authorNoam Postavsky <npostavs@gmail.com>
Thu, 8 Mar 2018 23:48:39 +0000 (18:48 -0500)
committerNoam Postavsky <npostavs@gmail.com>
Sat, 10 Mar 2018 22:56:04 +0000 (17:56 -0500)
* lisp/emacs-lisp/cl-macs.el (cl-case): Mention that the ATOM
=> (ATOM) short form is only for non-nil ATOMs.

lisp/emacs-lisp/cl-macs.el

index e7f82ced488e9dca363844658862c6e326f712b6..971f4f926bd24c7641e8cf9ea297656166c95840 100644 (file)
@@ -761,13 +761,15 @@ The result of the body appears to the compiler as a quoted constant."
 ;;;###autoload
 (defmacro cl-case (expr &rest clauses)
   "Eval EXPR and choose among clauses on that value.
-Each clause looks like (KEYLIST BODY...).  EXPR is evaluated and compared
-against each key in each KEYLIST; the corresponding BODY is evaluated.
-If no clause succeeds, cl-case returns nil.  A single atom may be used in
-place of a KEYLIST of one atom.  A KEYLIST of t or `otherwise' is
-allowed only in the final clause, and matches if no other keys match.
-Key values are compared by `eql'.
-\n(fn EXPR (KEYLIST BODY...)...)"
+Each clause looks like (KEYLIST BODY...).  EXPR is evaluated and
+compared against each key in each KEYLIST; the corresponding BODY
+is evaluated.  If no clause succeeds, cl-case returns nil.  A
+single non-nil atom may be used in place of a KEYLIST of one
+atom.  A KEYLIST of t or `otherwise' is allowed only in the final
+clause, and matches if no other keys match.  Key values are
+compared by `eql'.
+
+\(fn EXPR (KEYLIST BODY...)...)"
   (declare (indent 1) (debug (form &rest (sexp body))))
   (macroexp-let2 macroexp-copyable-p temp expr
     (let* ((head-list nil))