[latex3-commits] [git/LaTeX3-latex3-latex3] scan-quark: Also update quarks/scan marks in documentation (5f8dcc84e)

PhelypeOleinik tex.phelype at gmail.com
Sat Mar 21 02:49:16 CET 2020


Repository : https://github.com/latex3/latex3
On branch  : scan-quark
Link       : https://github.com/latex3/latex3/commit/5f8dcc84e4f18a07a9afc8c9285ebd0f74979607

>---------------------------------------------------------------

commit 5f8dcc84e4f18a07a9afc8c9285ebd0f74979607
Author: PhelypeOleinik <tex.phelype at gmail.com>
Date:   Fri Mar 20 22:49:16 2020 -0300

    Also update quarks/scan marks in documentation


>---------------------------------------------------------------

5f8dcc84e4f18a07a9afc8c9285ebd0f74979607
 l3kernel/l3basics.dtx      | 12 ++++++------
 l3kernel/l3expan.dtx       |  6 +++---
 l3kernel/l3fp-aux.dtx      |  2 +-
 l3kernel/l3int.dtx         |  6 +++---
 l3kernel/l3msg.dtx         |  2 +-
 l3kernel/l3prop.dtx        | 10 +++++-----
 l3kernel/l3sort.dtx        | 22 +++++++++++-----------
 l3kernel/l3str-convert.dtx | 10 +++++-----
 l3kernel/l3str.dtx         | 14 +++++++-------
 l3kernel/l3token.dtx       |  4 ++--
 10 files changed, 44 insertions(+), 44 deletions(-)

diff --git a/l3kernel/l3basics.dtx b/l3kernel/l3basics.dtx
index e0bd67928..af41ad123 100644
--- a/l3kernel/l3basics.dtx
+++ b/l3kernel/l3basics.dtx
@@ -2112,8 +2112,8 @@
 %   The setting-equal functions.  Split both functions and feed
 %   \Arg{name_1} \Arg{signature_1} \meta{boolean_1}
 %   \Arg{name_2} \Arg{signature_2} \meta{boolean_2}
-%   \meta{copying~function} \meta{conditions} |,| \cs{q_recursion_tail}
-%   |,| \cs{q_recursion_stop}
+%   \meta{copying~function} \meta{conditions} |,| \cs{q_@@_recursion_tail}
+%   |,| \cs{q_@@_recursion_stop}
 %   to a first auxiliary.
 %    \begin{macrocode}
 \cs_set_protected:Npn \prg_set_eq_conditional:NNn
@@ -2343,12 +2343,12 @@
 %   First ensure that we actually get a properly evaluated string by
 %   expanding \cs{cs_to_str:N} twice.  If the function contained a
 %   colon, the auxiliary takes as |#1| the function name, delimited by
-%   the first colon, then the signature |#2|, delimited by \cs{q_mark},
-%   then \cs{c_true_bool} as |#3|, and |#4| cleans up until \cs{q_stop}.
-%   Otherwise, the |#1| contains the function name and \cs{q_mark}
+%   the first colon, then the signature |#2|, delimited by \cs{s_@@_mark},
+%   then \cs{c_true_bool} as |#3|, and |#4| cleans up until \cs{s_@@_stop}.
+%   Otherwise, the |#1| contains the function name and \cs{s_@@_mark}
 %   \cs{c_true_bool}, |#2| is empty, |#3| is \cs{c_false_bool}, and |#4|
 %   cleans up.  The second
-%   auxiliary trims the trailing \cs{q_mark} from the function name if
+%   auxiliary trims the trailing \cs{s_@@_mark} from the function name if
 %   present (that is, if the original function had no colon).
 %    \begin{macrocode}
 \cs_set_protected:Npn \@@_tmp:w #1
diff --git a/l3kernel/l3expan.dtx b/l3kernel/l3expan.dtx
index 45538ed8c..fa218cb41 100644
--- a/l3kernel/l3expan.dtx
+++ b/l3kernel/l3expan.dtx
@@ -2246,7 +2246,7 @@
 %   \verb*|\protected |, \verb*|\protected\long |, |\first|, |\top|,
 %   |\bot|, |\splittop|, or |\splitbot|, with |\| replaced by the
 %   appropriate escape character.  If |pr| appears in the part before
-%   |ma|, the first \cs{q_mark} is taken as an argument of the |wwNw|
+%   |ma|, the first \cs{s_@@_mark} is taken as an argument of the |wwNw|
 %   auxiliary, and |#3| is \cs{cs_new_protected:Npx}, otherwise it
 %   is \cs{cs_new:Npx}.
 %    \begin{macrocode}
@@ -2341,8 +2341,8 @@
 %     We compare the base and variant signatures one character at a time
 %     within |x|-expansion.  The result is given to
 %     \cs{@@_generate_variant:wwNN} (defined later) in the form
-%     \meta{processed variant signature} \cs{q_mark} \meta{errors}
-%     \cs{q_stop} \meta{base function} \meta{new function}.  If all went
+%     \meta{processed variant signature} \cs{s_@@_mark} \meta{errors}
+%     \cs{s_@@_stop} \meta{base function} \meta{new function}.  If all went
 %     well, \meta{errors} is empty; otherwise, it is a kernel error
 %     message and some clean-up code.
 %
diff --git a/l3kernel/l3fp-aux.dtx b/l3kernel/l3fp-aux.dtx
index cc1ab7e85..ce9045b46 100644
--- a/l3kernel/l3fp-aux.dtx
+++ b/l3kernel/l3fp-aux.dtx
@@ -555,7 +555,7 @@
 %
 % \begin{macro}[EXP]{\@@_if_type_fp:NTwFw}
 %   Used as \cs{@@_if_type_fp:NTwFw} \meta{marker} \Arg{true code}
-%   \cs{s_@@} \Arg{false code} \cs{q_stop}, this test whether the
+%   \cs{s_@@} \Arg{false code} \cs{s_@@_stop}, this test whether the
 %   \meta{marker} is \cs{s_@@} or not and runs the appropriate
 %   \meta{code}.  The very unusual syntax is for optimization purposes
 %   as that function is used for all floating point operations.
diff --git a/l3kernel/l3int.dtx b/l3kernel/l3int.dtx
index da743044a..ae17a5b36 100644
--- a/l3kernel/l3int.dtx
+++ b/l3kernel/l3int.dtx
@@ -1558,7 +1558,7 @@
 %   \cs{@@_compare:w} receives as its argument an integer, a relation
 %   symbol, and some more tokens.  We then setup the loop, which is
 %   ended by the two odd-looking items |e| and |{=nd_}|, with a trailing
-%   \cs{q_stop} used to grab the entire argument when necessary.
+%   \cs{s_@@_stop} used to grab the entire argument when necessary.
 %    \begin{macrocode}
 \prg_new_conditional:Npnn \int_compare:n #1 { p , T , F , TF }
   {
@@ -2294,10 +2294,10 @@
 % \subsection{Converting from other formats to integers}
 %
 % \begin{macro}[rEXP]{\@@_pass_signs:wn, \@@_pass_signs_end:wn}
-%   Called as \cs{@@_pass_signs:wn} \meta{signs and digits} \cs{q_stop}
+%   Called as \cs{@@_pass_signs:wn} \meta{signs and digits} \cs{s_@@_stop}
 %   \Arg{code}, this function leaves in the input stream any sign it
 %   finds, then inserts the \meta{code} before the first non-sign token
-%   (and removes \cs{q_stop}).  More precisely, it deletes any~|+| and
+%   (and removes \cs{s_@@_stop}).  More precisely, it deletes any~|+| and
 %   passes any~|-| to the input stream, hence should be called in an
 %   integer expression.
 %    \begin{macrocode}
diff --git a/l3kernel/l3msg.dtx b/l3kernel/l3msg.dtx
index 47a27cb51..82d5d389c 100644
--- a/l3kernel/l3msg.dtx
+++ b/l3kernel/l3msg.dtx
@@ -2010,7 +2010,7 @@
 %   is an extra subtlety: if the user inserts tokens for error recovery,
 %   they should be kept. Thus we also use an odd space character
 %   (with category code $7$) and keep tokens until that space character,
-%   dropping everything else until \cs{q_stop}. The \cs{exp_end:} prevents
+%   dropping everything else until \cs{s_@@_stop}. The \cs{exp_end:} prevents
 %   losing braces around the user-inserted text if any, and stops the
 %   expansion of \cs{exp:w}.  The group is used to prevent
 %   |\LaTeX3~error:| from being globally equal to \cs{scan_stop:}.
diff --git a/l3kernel/l3prop.dtx b/l3kernel/l3prop.dtx
index c3b2e83c4..dfdefcebd 100644
--- a/l3kernel/l3prop.dtx
+++ b/l3kernel/l3prop.dtx
@@ -747,9 +747,9 @@
 %   trailing~|=| that we added).  For both splits trim spaces and call a
 %   function (first \cs{@@_from_keyval_key:w} then
 %   \cs{@@_from_keyval_value:w}), followed by the trimmed material,
-%   \cs{q_nil}, the subsequent part of the item, and the trailing |=|'s
-%   and \cs{q_stop}.  After finding the \meta{key} just store it after
-%   \cs{q_stop}.  After finding the \meta{value} ignore completely empty
+%   \cs{s_@@_mark}, the subsequent part of the item, and the trailing |=|'s
+%   and \cs{s_@@_stop}.  After finding the \meta{key} just store it after
+%   \cs{s_@@_stop}.  After finding the \meta{value} ignore completely empty
 %   items (both trailing~|=| were used as delimiters and all parts are
 %   empty); if the remaining part~|#2| consists exactly of the second
 %   trailing~|=| (namely there was exactly one |=|~in the item) then
@@ -837,7 +837,7 @@
 %   \begin{quote}
 %     \cs{cs_set:Npn} \cs{@@_split_aux:w} |#1| \\
 %     \quad \cs{@@_pair:wn} \meta{key} \cs{s_@@} |#2| \\
-%     \quad |#3| \cs{q_mark} |#4| |#5| \cs{q_stop} \\
+%     \quad |#3| \cs{s_@@_mark} |#4| |#5| \cs{s_@@_stop} \\
 %     \quad |{| |#4| \Arg{true code} \Arg{false code} |}|
 %   \end{quote}
 %
@@ -1176,7 +1176,7 @@
 %   most often empty.  When the \meta{key} is found in the list,
 %   \cs{@@_if_in:N} receives \cs{@@_pair:wn}, and if it is
 %   found as the extra item, the function receives
-%   \cs{q_recursion_tail}, easily recognizable.
+%   \cs{q_@@_recursion_tail}, easily recognizable.
 %
 %   Here, \cs{prop_map_function:NN} is not sufficient for the mapping,
 %   since it can only map a single token, and cannot carry the key that
diff --git a/l3kernel/l3sort.dtx b/l3kernel/l3sort.dtx
index 32cc1c96f..16ea793fe 100644
--- a/l3kernel/l3sort.dtx
+++ b/l3kernel/l3sort.dtx
@@ -576,7 +576,7 @@
 %   Each comparison should call \cs{sort_return_same:} or
 %   \cs{sort_return_swapped:} exactly once.  If neither is called,
 %   \cs{@@_return_none_error:} is called, since the \texttt{return_mark}
-%   removes tokens until \cs{q_mark}.  If one is called, the
+%   removes tokens until \cs{s_@@_mark}.  If one is called, the
 %   \texttt{return_mark} auxiliary removes everything except
 %   \cs{@@_return_same:w} (or its \texttt{swapped} analogue) followed by
 %   \cs{@@_return_none_error:}.  Finally if two or more are called,
@@ -716,7 +716,7 @@
 %     \tl_if_blank:nF {#1}
 %       {
 %         \__sort:nnNnn { } { } #2
-%           #1 \q_recursion_tail \q_recursion_stop
+%           #1 \q__sort_recursion_tail \q__sort_recursion_stop
 %       }
 %   }
 % \cs_new:Npn \__sort:nnNnn #1#2#3#4#5
@@ -751,7 +751,7 @@
 %   ~~~~~~\meta{extra arguments}\\
 %   ~~|}|\\
 %   \cs{@@_loop:wNn}~\ldots{}~\meta{prepared tokens}\\
-%   ~~\meta{end-loop}~|{}|~\cs{q_stop}
+%   ~~\meta{end-loop}~|{}|~\cs{s_@@_stop}
 % \end{quote}
 % In this example, which matches the structure of
 % \cs{@@_quick_split_i:NnnnnNn} and a few other functions below, the
@@ -791,13 +791,13 @@
 %
 % The third speed up is to avoid |\use:ff| using a continuation-passing
 % style: \cs{@@_quick_split:NnNn} expects a list followed by
-% \cs{q_mark} \Arg{code}, and expands to \meta{code} \meta{sorted list}.
+% \cs{s_@@_mark} \Arg{code}, and expands to \meta{code} \meta{sorted list}.
 % Sorting the two parts of the list around the pivot is done with
 % \begin{quote}
 %   \ttfamily
-%   \cs{@@_quick_split:NnNn} |#2| \ldots{} \cs{q_mark}\\
+%   \cs{@@_quick_split:NnNn} |#2| \ldots{} \cs{s_@@_mark}\\
 %   ~~|{|\\
-%   ~~~~\cs{@@_quick_split:NnNn} |#1| \ldots{} \cs{q_mark} \Arg{code}\\
+%   ~~~~\cs{@@_quick_split:NnNn} |#1| \ldots{} \cs{s_@@_mark} \Arg{code}\\
 %   ~~~~\Arg{pivot}\\
 %   ~~|}|
 % \end{quote}
@@ -832,7 +832,7 @@
 % argument of the third \cs{use:n}, hence must remain in memory, and so
 % on.  The memory consumption grows quadratically with the number of
 % nested \cs{use:n}.  In practice, this means that we must read
-% everything until a trailing \cs{q_stop} once in a while, otherwise
+% everything until a trailing \cs{s_@@_stop} once in a while, otherwise
 % sorting lists of more than a few thousand items would exhaust a
 % typical \TeX{}'s memory.
 %
@@ -855,8 +855,8 @@
 %   \texttt{prepare_end} auxiliary finds the prepared token list
 %   as~|#4|.  The scene is then set up for \cs{@@_quick_split:NnNn},
 %   which sorts the prepared list and perform the post action placed
-%   after \cs{q_mark}, namely removing the trailing \cs{s_stop} and
-%   \cs{q_stop} and leaving \cs{exp_stop_f:} to stop
+%   after \cs{s_@@_mark}, namely removing the trailing \cs{s_@@_stop} and
+%   \cs{s_@@_stop} and leaving \cs{exp_stop_f:} to stop
 %   \texttt{f}-expansion.
 %    \begin{macrocode}
 \cs_new:Npn \tl_sort:nN #1#2
@@ -970,9 +970,9 @@
 %   auxiliaries here) and another copy~|#6| of the fake item.  All those
 %   are discarded except the function~|#5|.  This function receives
 %   lists~|#1| and~|#2| of items less than or greater than the
-%   pivot~|#3|, then a continuation code~|#5| just after \cs{q_mark}.
+%   pivot~|#3|, then a continuation code~|#5| just after \cs{s_@@_mark}.
 %   To avoid a memory problem described earlier, all of the ending
-%   functions read~|#6| until \cs{q_stop} and place~|#6| back into the
+%   functions read~|#6| until \cs{s_@@_stop} and place~|#6| back into the
 %   input stream.  When the lists |#1| and~|#2| are empty, the
 %   \texttt{single} auxiliary simply places the continuation~|#5| before
 %   the pivot~|{#3}|.  When |#2|~is empty, |#1|~is sorted and placed
diff --git a/l3kernel/l3str-convert.dtx b/l3kernel/l3str-convert.dtx
index 0c6f1722f..2482047bd 100644
--- a/l3kernel/l3str-convert.dtx
+++ b/l3kernel/l3str-convert.dtx
@@ -2214,7 +2214,7 @@
 %   big-endianness. The three endianness cases are based on a common
 %   auxiliary whose first argument is $1$ for big-endian and $2$ for
 %   little-endian, and whose second argument, delimited by the scan mark
-%   \cs{s_stop}, is expanded once (the string may be long; passing
+%   \cs{s_@@_stop}, is expanded once (the string may be long; passing
 %   \cs{g_@@_result_tl} as an argument before expansion is cheaper).
 %
 %   The \cs{@@_decode_utf_xvi:Nw} function defines \cs{@@_tmp:w} to
@@ -2303,7 +2303,7 @@
 %   \hexnum{DC00} - \hexnum{10000}$.
 %
 %   Every time we read a pair of bytes, we test for the end-marker
-%   \cs{q_nil}. When reaching the end, we additionally check that the
+%   \cs{q_@@_nil}. When reaching the end, we additionally check that the
 %   string had an even length. Also, if the end is reached when
 %   expecting a trail surrogate, we treat that as a missing surrogate.
 %    \begin{macrocode}
@@ -2492,7 +2492,7 @@
 %
 %   The structure is similar to \textsc{utf-16} decoding functions. If
 %   the endianness is not given, test the first $4$ bytes of the string
-%   (possibly \cs{s_stop} if the string is too short) for the presence
+%   (possibly \cs{s_@@_stop} if the string is too short) for the presence
 %   of a byte-order mark. If there is a byte-order mark, use that
 %   endianness, and remove the $4$ bytes, otherwise default to
 %   big-endian, and leave the $4$ bytes in place. The
@@ -2504,13 +2504,13 @@
 %   inside an \texttt{x}-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
+%   marker \cs{s_@@_stop}, calling the \texttt{_end} auxiliary if
 %   appropriate. Otherwise, leave the \meta{4~bytes} \cs{s_@@} behind,
 %   then check that the code point is not overflowing: the leading byte
 %   must be $0$, and the following byte at most $16$.
 %
 %   In the ending code, we check that there remains no byte: there
-%   should be nothing left until the first \cs{s_stop}. Break the map.
+%   should be nothing left until the first \cs{s_@@_stop}. Break the map.
 %    \begin{macrocode}
   \cs_new_protected:cpn { @@_convert_decode_utf32be: }
     { \@@_decode_utf_xxxii:Nw 1 \g_@@_result_tl \s_@@_stop }
diff --git a/l3kernel/l3str.dtx b/l3kernel/l3str.dtx
index 08a3dde0a..bd396b219 100644
--- a/l3kernel/l3str.dtx
+++ b/l3kernel/l3str.dtx
@@ -1020,7 +1020,7 @@
 %   issues if we are fed a token list variable.  Then the code is a much
 %   simplified version of the token list code because neither the
 %   delimiter nor the replacement can contain macro parameters or
-%   braces.  The delimiter \cs{q_mark} cannot appear in the string to
+%   braces.  The delimiter \cs{s_@@_mark} cannot appear in the string to
 %   edit so it is used in all cases.  Some |x|-expansion is unnecessary.
 %   There is no need to avoid losing braces nor to protect against
 %   expansion.  The ending code is much simplified and does not need to
@@ -1322,12 +1322,12 @@
 %   These are received by \cs{@@_map_function:Nn}, which passes
 %   the space to |#1| and calls \cs{@@_map_function:w} to deal with the
 %   next space.  The space before the braced space allows to optimize
-%   the \cs{q_recursion_tail} test.  Of course we need to include a
+%   the \cs{q_@@_recursion_tail} test.  Of course we need to include a
 %   trailing space (the question mark is needed to avoid losing the
 %   space when \TeX{} tokenizes the line).
 %   At the cost of about three more auxiliaries this code could get a $9$
 %   times speed up by testing only every $9$-th character for whether it
-%   is \cs{q_recursion_tail} (also by converting $9$ spaces at a time in
+%   is \cs{q_@@_recursion_tail} (also by converting $9$ spaces at a time in
 %   the \cs{str_map_function:nN} case).
 %
 %   For the \texttt{map_variable} functions we use a string assignment
@@ -1420,11 +1420,11 @@
 % \begin{macro}[EXP]{\@@_to_other_loop:w, \@@_to_other_end:w}
 %   First apply \cs{tl_to_str:n}, then replace all spaces by
 %   \enquote{other} spaces, $8$ at a time, storing the converted part of
-%   the string between the \cs{q_mark} and \cs{q_stop} markers.  The end
+%   the string between the \cs{s_@@_mark} and \cs{s_@@_stop} markers.  The end
 %   is detected when \cs{@@_to_other_loop:w} finds one of the trailing
 %   |A|, distinguished from any contents of the initial token list by
 %   their category.  Then \cs{@@_to_other_end:w} is called, and finds
-%   the result between \cs{q_mark} and the first |A| (well, there is
+%   the result between \cs{s_@@_mark} and the first |A| (well, there is
 %   also the need to remove a space).
 %    \begin{macrocode}
 \cs_new:Npn \__kernel_str_to_other:n #1
@@ -1677,7 +1677,7 @@
 %     \@@_collect_end:wn, \@@_collect_end:nnnnnnnnw
 %   }
 %   Collects |max(#1,0)| characters, and removes everything else until
-%   \cs{q_stop}. This is somewhat similar to \cs{@@_skip_exp_end:w}, but
+%   \cs{s_@@_stop}. This is somewhat similar to \cs{@@_skip_exp_end:w}, but
 %   accepts integer expression arguments.  This time we can only grab
 %   $7$ characters at a time.  At the end, we use an \cs{if_case:w}
 %   trick again, so that the $8$ first arguments of
@@ -1865,7 +1865,7 @@
 %   end-marker |X| be unexpandable and not a control sequence).  The
 %   \texttt{_ignore_spaces} is rather simpler: after converting the
 %   input to a string, \cs{@@_tail_auxii:w} removes one undelimited
-%   argument and leaves everything else until an end-marker \cs{q_mark}.
+%   argument and leaves everything else until an end-marker \cs{s_@@_mark}.
 %   One can check that an empty (or blank) string yields an empty
 %   tail.
 %    \begin{macrocode}
diff --git a/l3kernel/l3token.dtx b/l3kernel/l3token.dtx
index 23e9ce89d..d0af3b6c0 100644
--- a/l3kernel/l3token.dtx
+++ b/l3kernel/l3token.dtx
@@ -2231,7 +2231,7 @@
 %   conditionals which detect whether the \tn{meaning} of their
 %   argument begins with a particular string.  Each auxiliary takes an
 %   argument delimited by a string, a second one delimited by
-%   \cs{q_stop}, and returns the first one and its delimiter.
+%   \cs{s_@@_stop}, and returns the first one and its delimiter.
 %   This result is eventually compared to another string.
 %    \begin{macrocode}
 \group_begin:
@@ -2387,7 +2387,7 @@
 %   nonexistent depending on \tn{endlinechar}), and takes care
 %   of three of the exceptions: \tn{space}, \tn{italiccorr}
 %   and \tn{hyphen}, whose meaning is at most two characters.
-%   This leaves a string terminated by some |:|, and \cs{q_stop}.
+%   This leaves a string terminated by some |:|, and \cs{s_@@_stop}.
 %
 %   The meaning of each one of the five \tn[no-index]{...mark} primitives
 %   has the form \meta{letters}|:|\meta{user material}. In other words,





More information about the latex3-commits mailing list.