[Emacs-diffs] fix/bug-31311-pcase-doc 3562c19 3/9: expand EXPVAL-in-docstring para

[Thien-Thi Nguyen]

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

    expand EXPVAL-in-docstring para
    
    - drop "documentation consistency" (bloviation)
    - mention "arrange to ... along w/ ‘pcase’"
    - mention "convention"
---
 doc/lispref/control.texi | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi
index cd3c32c..4ae9ad0 100644
--- a/doc/lispref/control.texi
+++ b/doc/lispref/control.texi
@@ -864,8 +864,10 @@ should describe how to rewrite the pattern @var{name} into 
some other
 pattern.  The rewriting will be the result of evaluating @var{body}
 in an environment where @var{args} are bound to @var{actual-args}.
 
-For documentation consistency, use @code{EXPVAL}
-in @var{doc}, the docstring, to stand for the result of
+Additionally, arrange to display @var{doc} along with
+the docstring of @code{pcase}.
+By convention, @var{doc} should use @code{EXPVAL}
+to stand for the result of
 evaluating @var{expression} (first arg to @code{pcase}).
 @end defmac