[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] fix/bug-3133-pcase-doc dcb6d91 04/13: further refinement:
From: |
Thien-Thi Nguyen |
Subject: |
[Emacs-diffs] fix/bug-3133-pcase-doc dcb6d91 04/13: further refinement: introduce @var{expval}; GSR |
Date: |
Fri, 11 May 2018 12:50:51 -0400 (EDT) |
branch: fix/bug-3133-pcase-doc
commit dcb6d911489ce38fe16fd71ad57fb513ae587ad7
Author: Thien-Thi Nguyen <address@hidden>
Commit: Thien-Thi Nguyen <address@hidden>
further refinement: introduce @var{expval}; GSR
---
doc/lispref/control.texi | 29 ++++++++++++++---------------
1 file changed, 14 insertions(+), 15 deletions(-)
diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi
index b155975..d546e9b 100644
--- a/doc/lispref/control.texi
+++ b/doc/lispref/control.texi
@@ -375,8 +375,8 @@ forms: ``unquoted'' and ``quoted'', also known as
A Q-pattern begins with a backquote and often builds
upon one or more simpler U-patterns.
-Note: In the following description, the ``value being matched''
-refers to the result of evaluating @var{expression}
+Note: In the following description, @var{expval} stands
+for the result of evaluating @var{expression}
(first argument to @code{pcase}).
A U-pattern can have the following forms:
@@ -384,7 +384,7 @@ A U-pattern can have the following forms:
@table @code
@item '@var{val}
-Matches if the value being matched is @code{equal} to @var{val}.
+Matches if @var{expval} is @code{equal} to @var{val}.
@item @var{keyword}
@itemx @var{integer}
@@ -403,13 +403,13 @@ value it matched, so that you can later refer to it,
either in the
@item (pred @var{predfun})
Matches if the predicate function @var{predfun} returns address@hidden
-when called with the value being matched as its argument.
+when called with @var{expval} as its argument.
@var{predfun} can be one of the possible forms described below.
@item (guard @var{boolean-expression})
Matches if @var{boolean-expression} evaluates to address@hidden This
allows you to include in a U-pattern boolean conditions that refer to
-symbols bound to values (including the value being matched) by
+symbols bound to values (including @var{expval}) by
previous U-patterns. Typically used inside an @code{and} U-pattern, see
below. For example, @address@hidden(and x (guard (< x 10)))}} is a pattern
which matches any number smaller than 10 and let-binds the variable
@@ -425,7 +425,7 @@ U-pattern. For example:
@address@hidden((or `(key . ,val) (let val 5)) val)}}.)
@item (app @var{function} @var{upattern})
-Matches if @var{function} applied to the value being matched returns a
+Matches if @var{function} applied to @var{expval} returns a
value that matches @var{upattern}. This is like the @code{pred}
U-pattern, except that it tests the result against @var{upattern},
rather than against a boolean truth value. The @var{function} call can
@@ -446,17 +446,16 @@ can have one of the following forms:
@table @asis
@item function name (a symbol), e.g., @code{integerp}
-In this case, the named function is applied to the value being
-matched.
+In this case, the named function is applied to @var{expval}.
@item lambda expression, e.g., @code{(lambda (n) (= 42 n))}
-In this case, the lambda expression is called with one argument, the
-value being matched.
+In this case, the lambda expression is called with one argument,
address@hidden
@item function call with @var{n} args, e.g., @code{(= 42)}
This is a function call with @var{n} specified arguments; the function
is called with these @var{n} arguments and an additional @var{n}+1-th
-argument that is the value being matched.
+argument that is @var{expval}.
@end table
@noindent
@@ -487,22 +486,22 @@ Backquoted patterns have the form @address@hidden where
@table @code
@item (@var{qpattern1} . @var{qpattern2})
-Matches if the value being matched is a cons cell whose @code{car}
+Matches if @var{expval} is a cons cell whose @code{car}
matches @var{qpattern1} and whose @code{cdr} matches @var{qpattern2}.
This readily generalizes to backquoted lists as in
@address@hidden(@var{qpattern1} @var{qpattern2} @dots{})}}.
@item address@hidden @var{qpattern2} @dots{} @var{qpatternm}]
-Matches if the value being matched is a vector of length @var{m} whose
+Matches if @var{expval} is a vector of length @var{m} whose
@address@hidden(@var{m}-1)}th elements match @var{qpattern1},
@var{qpattern2} @dots{} @var{qpatternm}, respectively.
@item @var{atom}
-Matches if corresponding element of the value being matched is
+Matches if corresponding element of @var{expval} is
@code{equal} to the specified @var{atom}.
@item ,@var{upattern}
-Matches if the corresponding element of the value being matched
+Matches if the corresponding element of @var{expval}
matches the specified @var{upattern}.
@end table
- [Emacs-diffs] branch fix/bug-3133-pcase-doc created (now 82791b1), Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc 7b00deb 02/13: add @cindex entry for ‘backquote’, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc 0f42499 03/13: refine "value being matched" note, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc edae74f 09/13: (docstring) update elisp.info ref, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc dcb6d91 04/13: further refinement: introduce @var{expval}; GSR,
Thien-Thi Nguyen <=
- [Emacs-diffs] fix/bug-3133-pcase-doc 80ed201 07/13: (docstring) explode "ATOM"; flatten; zonk "match themselves" sentence, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc f927f6a 10/13: (docstring) move { 'VAL, KEYWORD, INTEGER, STRING } prior to SYMBOL, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc 82791b1 13/13: (docstring) move ‘FUN’ para after after logical pattern table; refine, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc c3d1896 12/13: (docstring) rework middle, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc fdbdb64 05/13: more @var{expval} insinuation, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc fa03d3a 06/13: (docstring) rewrite first para, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc dc67ead 08/13: (docstring) use ‘EXPVAL’ more, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc 1181796 01/13: do ‘s/UPattern/U-pattern/g’, ‘s/QPattern/Q-pattern/g’, Thien-Thi Nguyen, 2018/05/11
- [Emacs-diffs] fix/bug-3133-pcase-doc 9449c39 11/13: pxref ‘Lambda Expressions’, Thien-Thi Nguyen, 2018/05/11