diff options
| author | Thien-Thi Nguyen <ttn@gnu.org> | 2018-05-21 17:11:55 +0200 |
|---|---|---|
| committer | Thien-Thi Nguyen <ttn@gnu.org> | 2018-05-27 10:36:35 +0200 |
| commit | 7e8227ed68357dd05cb7a4ce931e5cafe6c9dd5a (patch) | |
| tree | 8d618808fb62cfcbebe90d46692b083fc979b733 | |
| parent | e6de5b3d51558ef861df68bcda2c4e91afe2d9ef (diff) | |
| download | emacs-7e8227ed68357dd05cb7a4ce931e5cafe6c9dd5a.tar.gz | |
Introduce EXPVAL for pcase, pcase-defmacro docstrings
Suggested by Drew Adams (Bug#31311).
* lisp/emacs-lisp/pcase.el (pcase): Use EXPVAL in
docstring to stand for the result of evaluating EXP.
(pcase-defmacro): Add (fn ...) form in docstring
that includes [DOC], and the EXPVAL convention.
| -rw-r--r-- | lisp/emacs-lisp/pcase.el | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/emacs-lisp/pcase.el b/lisp/emacs-lisp/pcase.el index 6e8f08e699a..38e434de375 100644 --- a/lisp/emacs-lisp/pcase.el +++ b/lisp/emacs-lisp/pcase.el @@ -108,7 +108,7 @@ ;;;###autoload (defmacro pcase (exp &rest cases) - "Evaluate EXP and attempt to match it against structural patterns. + "Evaluate EXP to get EXPVAL; try passing control to one of CASES. CASES is a list of elements of the form (PATTERN CODE...). A structural PATTERN describes a template that identifies a class @@ -427,7 +427,11 @@ any kind of error." (defmacro pcase-defmacro (name args &rest body) "Define a new kind of pcase PATTERN, by macro expansion. Patterns of the form (NAME ...) will be expanded according -to this macro." +to this macro. + +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. |