From: Stefan Kangas <stefan@marxist.se>
Date: Sun, 19 Sep 2021 15:25:39 +0000 (+0200)
Subject: Clarify docstring of pcase-exhaustive
X-Git-Tag: emacs-28.0.90~832
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=86837a87b7acc04814ec126d00cd3ef095de3012;p=emacs.git

Clarify docstring of pcase-exhaustive

* lisp/emacs-lisp/pcase.el (pcase-exhaustive): Clarify docstring
by contrasting with pcase.  (Bug#44166)
---

diff --git a/lisp/emacs-lisp/pcase.el b/lisp/emacs-lisp/pcase.el
index c6173c710f7..a3498d2da8d 100644
--- a/lisp/emacs-lisp/pcase.el
+++ b/lisp/emacs-lisp/pcase.el
@@ -201,7 +201,11 @@ Emacs Lisp manual for more information and examples."
 ;;;###autoload
 (defmacro pcase-exhaustive (exp &rest cases)
   "The exhaustive version of `pcase' (which see).
-If EXP fails to match any of the patterns in CASES, an error is signaled."
+If EXP fails to match any of the patterns in CASES, an error is
+signaled.
+
+In contrast, `pcase' will return nil if there is no match, but
+not signal an error."
   (declare (indent 1) (debug pcase))
   (let* ((x (gensym "x"))
          (pcase--dontwarn-upats (cons x pcase--dontwarn-upats)))