[Emacs-diffs] fix/bug-31311-pcase-doc 2a1f380 1/3: (docstring) add (fn ...) for pcase-defmacro, to include DOC

[Thien-Thi Nguyen]

branch: fix/bug-31311-pcase-doc
commit 2a1f380f8af00c116aaffe9e9736f00facda470f
Author: Thien-Thi Nguyen <address@hidden>
Commit: Thien-Thi Nguyen <address@hidden>

    (docstring) add (fn ...) for pcase-defmacro, to include DOC
---
 lisp/emacs-lisp/pcase.el | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lisp/emacs-lisp/pcase.el b/lisp/emacs-lisp/pcase.el
index ee206a5..fa7b1de 100644
--- a/lisp/emacs-lisp/pcase.el
+++ b/lisp/emacs-lisp/pcase.el
@@ -414,8 +414,9 @@ any kind of error."
 Patterns of the form (NAME ...) will be expanded according
 to this macro.
 
-For documentation consistency, use \"EXPVAL\" in the docstring
-to stand for the result of evaluating EXP (first arg to `pcase')."
+By convention, DOC should use \"EXPVAL\" to stand
+for the result of evaluating EXP (first arg to `pcase').
+\n(fn NAME ARGS [DOC] &rest BODY...)"
   (declare (indent 2) (debug defun) (doc-string 3))
   ;; Add the function via `fsym', so that an autoload cookie placed
   ;; on a pcase-defmacro will cause the macro to be loaded on demand.