[latex3-commits] [latex3/latex3] main: Adapt doc and code comments to sync with x-to-e switch (a1fc7dfba)
github at latex-project.org
github at latex-project.org
Mon Oct 30 23:02:46 CET 2023
Repository : https://github.com/latex3/latex3
On branch : main
Link : https://github.com/latex3/latex3/commit/a1fc7dfbaecdcbd24ef32a33f0b1ff04a01a9a88
>---------------------------------------------------------------
commit a1fc7dfbaecdcbd24ef32a33f0b1ff04a01a9a88
Author: Yukai Chou <muzimuzhi at gmail.com>
Date: Tue Oct 31 04:40:43 2023 +0800
Adapt doc and code comments to sync with x-to-e switch
>---------------------------------------------------------------
a1fc7dfbaecdcbd24ef32a33f0b1ff04a01a9a88
l3kernel/l3basics.dtx | 2 +-
l3kernel/l3candidates.dtx | 2 +-
l3kernel/l3clist.dtx | 2 +-
l3kernel/l3deprecation.dtx | 2 +-
l3kernel/l3file.dtx | 4 ++--
l3kernel/l3keys.dtx | 2 +-
l3kernel/l3msg.dtx | 4 ++--
l3kernel/l3prop.dtx | 2 +-
l3kernel/l3regex.dtx | 16 ++++++++--------
l3kernel/l3seq.dtx | 10 +++++-----
l3kernel/l3str-convert.dtx | 4 ++--
l3kernel/l3token.dtx | 4 ++--
12 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/l3kernel/l3basics.dtx b/l3kernel/l3basics.dtx
index f749dd58b..17eb49f2c 100644
--- a/l3kernel/l3basics.dtx
+++ b/l3kernel/l3basics.dtx
@@ -3259,7 +3259,7 @@
% wrapping code as otherwise we would wrongly see the definitions that
% are in place there. To get correct escape characters, set the
% \tn{escapechar} in a group; this also localizes the assignment
-% performed by \texttt{x}-expansion. The \cs{cs_show:c} and \cs{cs_log:c} commands
+% performed by \texttt{e}-expansion. The \cs{cs_show:c} and \cs{cs_log:c} commands
% convert their argument to a control sequence within a group to avoid
% showing \tn{relax} for undefined control sequences.
% \begin{macrocode}
diff --git a/l3kernel/l3candidates.dtx b/l3kernel/l3candidates.dtx
index 5e8275377..c11987fcc 100644
--- a/l3kernel/l3candidates.dtx
+++ b/l3kernel/l3candidates.dtx
@@ -138,7 +138,7 @@
% and skipping out of that would break horribly.
% The \cs{@@_wrap_item:n} function inserts the relevant
% \cs{@@_item:n} without expansion in the input stream,
-% hence in the \texttt{x}-expanding assignment.
+% hence in the \texttt{e}-expanding assignment.
% \begin{macrocode}
\cs_new_protected:Npn \seq_set_filter:NNn
{ \@@_set_filter:NNNn \__kernel_tl_set:Ne }
diff --git a/l3kernel/l3clist.dtx b/l3kernel/l3clist.dtx
index 7c6ccf506..dec8c0d8f 100644
--- a/l3kernel/l3clist.dtx
+++ b/l3kernel/l3clist.dtx
@@ -1523,7 +1523,7 @@
% \clist_reverse:N, \clist_reverse:c,
% \clist_greverse:N, \clist_greverse:c
% }
-% Use \cs{clist_reverse:n} in an \texttt{x}-expanding assignment. The
+% Use \cs{clist_reverse:n} in an \texttt{e}-expanding assignment. The
% extra work that \cs{clist_reverse:n} does to preserve braces and
% spaces would not be needed for the well-controlled case of
% \texttt{N}-type comma lists, but the slow-down is not too bad.
diff --git a/l3kernel/l3deprecation.dtx b/l3kernel/l3deprecation.dtx
index 9d4640ae5..3d44db5a3 100644
--- a/l3kernel/l3deprecation.dtx
+++ b/l3kernel/l3deprecation.dtx
@@ -137,7 +137,7 @@
% In case we want a warning, the \meta{function} is defined to produce
% such a warning without grabbing any argument, then redefine itself
% to the standard definition that the \meta{function} should have,
-% with arguments, and call that definition. The \texttt{x}-type
+% with arguments, and call that definition. The \texttt{e}-type
% expansion and \cs{exp_not:n} avoid needing to double the~|#|, which
% we could not do anyways. We then deal with the code for
% \cs{debug_off:n} |{deprecation}|: presumably someone doing that does
diff --git a/l3kernel/l3file.dtx b/l3kernel/l3file.dtx
index 2069d3721..ee0a4bee8 100644
--- a/l3kernel/l3file.dtx
+++ b/l3kernel/l3file.dtx
@@ -486,7 +486,7 @@
% \end{syntax}
% This function writes \meta{tokens} to the specified
% \meta{stream} when the current page is finalised (\emph{i.e.}~at
-% shipout). The \texttt{x}-type variants expand the \meta{tokens}
+% shipout). The \texttt{e}-type variants expand the \meta{tokens}
% at the point where the function is used but \emph{not} when the
% resulting tokens are written to the \meta{stream}
% (\emph{cf.}~\cs{iow_shipout_e:Nn}).
@@ -597,7 +597,7 @@
% output does \emph{not} expand further when written to a file.
%
% \begin{texnote}
-% Internally, \cs{iow_wrap:nnnN} carries out an \texttt{x}-type expansion
+% Internally, \cs{iow_wrap:nnnN} carries out an \texttt{e}-type expansion
% on the \meta{text} to expand it. This is done in such a way that
% \cs{exp_not:N} or \cs{exp_not:n} \emph{could} be used to prevent
% expansion of material. However, this is less conceptually clear than
diff --git a/l3kernel/l3keys.dtx b/l3kernel/l3keys.dtx
index bb3314db7..e0478888d 100644
--- a/l3kernel/l3keys.dtx
+++ b/l3kernel/l3keys.dtx
@@ -1805,7 +1805,7 @@
% }
% Searching for a property means finding the last |.| in the input,
% and storing the text before and after it. Everything is turned into
-% strings, so there is no problem using an \texttt{x}-type expansion. Since
+% strings, so there is no problem using an \texttt{e}-type expansion. Since
% \cs{@@_trim_spaces:n} will turn its argument into a string anyway, this
% function uses \cs{cs_set_nopar:Npe} instead of \cs{tl_set:Ne} to gain some
% speed.
diff --git a/l3kernel/l3msg.dtx b/l3kernel/l3msg.dtx
index 382aab68d..1e79e98ca 100644
--- a/l3kernel/l3msg.dtx
+++ b/l3kernel/l3msg.dtx
@@ -288,7 +288,7 @@
% message, extra arguments are ignored, or empty arguments added (of
% course the sense of the message may be impaired). The four arguments are
% converted to strings before being added to the message text: the
-% \texttt{x}-type variants should be used to expand material.
+% \texttt{e}-type variants should be used to expand material.
% Note that this expansion takes place with the standard definitions in
% effect, which means that shorthands such as |\~| or |\\| are
% \emph{not} available; instead one should use \cs{iow_char:N} |\~| and
@@ -961,7 +961,7 @@
% \begin{macro}{\@@_interrupt_text:n, \@@_interrupt_more_text:n}
% First setup \TeX{}'s \tn{errhelp} register with the extra help |#1|,
% then build a nice-looking error message with |#2|. Everything is
-% done using \texttt{x}-type expansion as the new line markers are
+% done using \texttt{e}-type expansion as the new line markers are
% different for the two type of text and need to be correctly set up.
% The auxiliary \cs{@@_interrupt_more_text:n} receives its argument
% as a line-wrapped string, which is thus unaffected by expansion.
diff --git a/l3kernel/l3prop.dtx b/l3kernel/l3prop.dtx
index fb64b6d96..45578ae64 100644
--- a/l3kernel/l3prop.dtx
+++ b/l3kernel/l3prop.dtx
@@ -1258,7 +1258,7 @@
% \meta{value} may contain arbitrary tokens, it is not safe to include
% them in the argument of \cs{@@_split:NnTF}. We thus start by
% storing in \cs{l_@@_internal_tl} tokens which (after
-% \texttt{x}-expansion) encode the key--value pair. This variable can
+% \texttt{e}-expansion) encode the key--value pair. This variable can
% safely be used in \cs{@@_split:NnTF}. If the \meta{key} was absent,
% append the new key--value to the list.
% Otherwise concatenate the extracts |##1|
diff --git a/l3kernel/l3regex.dtx b/l3kernel/l3regex.dtx
index 5e913a888..833bdd1b5 100644
--- a/l3kernel/l3regex.dtx
+++ b/l3kernel/l3regex.dtx
@@ -1090,7 +1090,7 @@
% When actually building the result,
% \begin{itemize}
% \item \tn{toks}\meta{position} holds \meta{tokens} which \texttt{o}-
-% and \texttt{x}-expand to the \meta{position}-th token in the query.
+% and \texttt{e}-expand to the \meta{position}-th token in the query.
% \item \cs{g_@@_balance_intarray} holds the balance of begin-group and
% end-group character tokens which appear before that point in the
% token list.
@@ -1160,12 +1160,12 @@
%
% \begin{macro}{\@@_toks_put_left:Ne}
% \begin{macro}{\@@_toks_put_right:Ne, \@@_toks_put_right:Nn}
-% During the building phase we wish to add \texttt{x}-expanded
+% During the building phase we wish to add \texttt{e}-expanded
% material to \tn{toks}, either to the left or to the right. The
% expansion is done \enquote{by hand} for optimization (these
% operations are used quite a lot). The \texttt{Nn} version of
% \cs{@@_toks_put_right:Ne} is provided because it is more
-% efficient than \texttt{x}-expanding with \cs{exp_not:n}.
+% efficient than \texttt{e}-expanding with \cs{exp_not:n}.
% \begin{macrocode}
\cs_new_protected:Npn \@@_toks_put_left:Ne #1#2
{
@@ -1188,7 +1188,7 @@
% \begin{macro}[rEXP]{\@@_curr_cs_to_str:}
% Expands to the string representation of the token (known to be a
% control sequence) at the current position \cs{l_@@_curr_pos_int}.
-% It should only be used in \texttt{x}-expansion to avoid losing a
+% It should only be used in \texttt{e}/\texttt{x}-expansion to avoid losing a
% leading space.
% \begin{macrocode}
\cs_new:Npn \@@_curr_cs_to_str:
@@ -1705,14 +1705,14 @@
% a string, then read from left to right, interpreting backslashes as
% escaping the next character. Unescaped characters are fed to the
% function \meta{inline~1}, and escaped characters are fed to the function
-% \meta{inline~2} within an \texttt{x}-expansion context (typically those
+% \meta{inline~2} within an \texttt{e}-expansion context (typically those
% functions perform some tests on their argument to decide how to output
% them). The escape sequences |\a|, |\e|, |\f|, |\n|, |\r|, |\t| and
% |\x| are recognized, and those are replaced by the corresponding
% character, then fed to \meta{inline~3}. The result is then left in the
% input stream. Spaces are ignored unless escaped.
%
-% The conversion is done within an \texttt{x}-expanding assignment.
+% The conversion is done within an \texttt{e}-expanding assignment.
%
% \begin{macro}{\@@_escape_use:nnnn}
% The result is built in \cs{l_@@_internal_a_tl}, which is then left
@@ -2393,7 +2393,7 @@
% \begin{macro}{\@@_compile:w, \@@_compile_end:}
% Used when compiling a user regex or a regex for the |\c{...}| escape
% sequence within another regex. Start building a token list within a
-% group (with \texttt{x}-expansion at the outset), and set a few
+% group (with \texttt{e}-expansion at the outset), and set a few
% variables (group level, catcodes), then start the first branch. At
% the end, make sure there are no dangling classes nor groups, close
% the last branch: we are done building \cs{l_@@_internal_regex}.
@@ -3638,7 +3638,7 @@
%
% \begin{macro}[EXP]{\@@_compile_u_loop:NN}
% We collect the characters for the argument of |\u| within an
-% \texttt{x}-expanding assignment. In principle we could just wait to
+% \texttt{e}-expanding assignment. In principle we could just wait to
% encounter a right brace, but this is unsafe: if the right brace was
% missing, then we would reach the end-markers of the regex, and
% continue, leading to obscure fatal errors. Instead, we only allow
diff --git a/l3kernel/l3seq.dtx b/l3kernel/l3seq.dtx
index ecc6eae2f..254d67f2e 100644
--- a/l3kernel/l3seq.dtx
+++ b/l3kernel/l3seq.dtx
@@ -1310,12 +1310,12 @@
% is a repetition of the pattern
% \cs{@@_set_split_auxi:w} \cs{prg_do_nothing:}
% \meta{item with spaces} \cs{@@_set_split_end:}.
-% Then, \texttt{x}-expansion causes \cs{@@_set_split_auxi:w}
+% Then, \texttt{e}-expansion causes \cs{@@_set_split_auxi:w}
% to trim spaces, and leaves its result as
% \cs{@@_set_split_auxii:w} \meta{trimmed item}
% \cs{@@_set_split_end:}. This is then converted
% to the \pkg{l3seq} internal structure by another
-% \texttt{x}-expansion. In the first step, we insert
+% \texttt{e}-expansion. In the first step, we insert
% \cs{prg_do_nothing:} to avoid losing braces too early:
% that would cause space trimming to act within those
% lost braces. The second step is solely there to strip
@@ -1480,7 +1480,7 @@
%
% \begin{macro}{\@@_wrap_item:n}
% This function converts its argument to a proper sequence item
-% in an \texttt{x}-expansion context.
+% in an \texttt{e}-expansion context.
% \begin{macrocode}
\cs_new:Npn \@@_wrap_item:n #1 { \exp_not:n { \@@_item:n {#1} } }
% \end{macrocode}
@@ -1993,7 +1993,7 @@
% use some of the same ideas as getting from the right. What is needed is a
% \enquote{flexible length} way to set a token list variable. This is
% supplied by the |{ \if_false: } \fi:| \ldots
-% |\if_false: { \fi: }| construct. Using an \texttt{x}-type
+% |\if_false: { \fi: }| construct. Using an \texttt{e}-type
% expansion and a \enquote{non-expanding} definition for \cs{@@_item:n},
% the left-most $n - 1$ entries in a sequence of $n$ items are stored
% back in the sequence. That needs a loop of unknown length, hence using the
@@ -2280,7 +2280,7 @@
% }
% \UnitTested
% This is just a specialised version of the in-line mapping function,
-% using an \texttt{x}-type expansion for the code set up so that the
+% using an \texttt{e}-type expansion for the code set up so that the
% number of |#| tokens required is as expected.
% \begin{macrocode}
\cs_new_protected:Npn \seq_map_variable:NNn #1#2#3
diff --git a/l3kernel/l3str-convert.dtx b/l3kernel/l3str-convert.dtx
index c4fc416d4..266238873 100644
--- a/l3kernel/l3str-convert.dtx
+++ b/l3kernel/l3str-convert.dtx
@@ -979,7 +979,7 @@
% non-Unicode-aware engines we use a fall-back character |?| rather
% than nothing when given a character code outside $[0,255]$. We
% detect the presence of bad characters using a flag and only produce
-% a single error after the \texttt{x}-expanding assignment.
+% a single error after the \texttt{e}-expanding assignment.
% \begin{macrocode}
\bool_lazy_any:nTF
{
@@ -2515,7 +2515,7 @@
% its second argument (expanded or not). It sets \cs{@@_tmp:w} to
% expand to the character code of either of its two arguments
% depending on endianness, then triggers the \texttt{_loop} auxiliary
-% inside an \texttt{x}-expanding assignment to \cs{g_@@_result_tl}.
+% inside an \texttt{e}-expanding assignment to \cs{g_@@_result_tl}.
%
% The \texttt{_loop} auxiliary first checks for the end-of-string
% marker \cs{s_@@_stop}, calling the \texttt{_end} auxiliary if
diff --git a/l3kernel/l3token.dtx b/l3kernel/l3token.dtx
index 01302f1ab..49c1a1da7 100644
--- a/l3kernel/l3token.dtx
+++ b/l3kernel/l3token.dtx
@@ -968,7 +968,7 @@
% receives three arguments for each \meta{token} in the input stream:
% \begin{itemize}
% \item \meta{tokens}, which both \texttt{o}-expand and
-% \texttt{x}-expand to the \meta{token}. The detailed form of
+% \texttt{e}/\texttt{x}-expand to the \meta{token}. The detailed form of
% \meta{tokens} may change in later releases.
% \item \meta{char code}, a decimal representation of the character
% code of the \meta{token}, $-1$ if it is a control sequence.
@@ -2328,7 +2328,7 @@
%
% Characters used as delimiters must have catcode~$12$
% and are obtained through \cs{tl_to_str:n}. This requires doing all
-% definitions within \texttt{x}-expansion. The temporary function
+% definitions within \texttt{e}-expansion. The temporary function
% \cs{@@_tmp:w} used to define each conditional receives three
% arguments: the name of the conditional, the auxiliary's delimiter
% (also used to name the auxiliary), and the string to which one
More information about the latex3-commits
mailing list.