[latex3-commits] [git/LaTeX3-latex3-latex3] scan-quark: Correct code documentation of \__kernel_quark_new_ functions (16907ff5f)

[Bruno Le Floch]

Repository : https://github.com/latex3/latex3
On branch  : scan-quark
Link       : https://github.com/latex3/latex3/commit/16907ff5fce51f65eb31a0b5f23744b5cb075b22

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

commit 16907ff5fce51f65eb31a0b5f23744b5cb075b22
Author: Bruno Le Floch <bruno at le-floch.fr>
Date:   Wed May 6 11:16:26 2020 +0200

    Correct code documentation of \__kernel_quark_new_ functions


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

16907ff5fce51f65eb31a0b5f23744b5cb075b22
 l3kernel/l3quark.dtx | 43 +++++++++++++++++++++++--------------------
 1 file changed, 23 insertions(+), 20 deletions(-)

diff --git a/l3kernel/l3quark.dtx b/l3kernel/l3quark.dtx
index fbb5303a5..93b7362da 100644
--- a/l3kernel/l3quark.dtx
+++ b/l3kernel/l3quark.dtx
@@ -592,36 +592,39 @@
 %
 % \begin{macro}{\__kernel_quark_new_test:N}
 %   The function \cs{__kernel_quark_new_test:N} defines |#1| in a
-%   similar way as
-%   \cs[no-index]{quark_if_recursion_tail_stop(_do):(N|n)(n)}.  using
-%   \cs[no-index]{q\meta{namespace}_recursion_tail} as the test quark
-%   and \cs[no-index]{q\meta{namespace}_recursion_stop} as the delimiter
-%   quark, where the \meta{namespace} is given by |#2| (for example
-%   |__test|).
+%   similar way as \cs[no-index]{quark_if_recursion_tail_...} functions
+%   (as described below), using
+%   \cs[no-index]{q__\meta{namespace}_recursion_tail} as the test quark
+%   and \cs[no-index]{q__\meta{namespace}_recursion_stop} as the
+%   delimiter quark, where the \meta{namespace} is determined as the
+%   first |_|-delimited part in~|#1|.
 %
 %   There are six possible function types which this function can define,
 %   and which is defined depends on the signature of the function being
 %   defined:
 %   \begin{description}
-%     \item[\texttt{:n}:~]  defines \cs{quark_if_recursion_tail_stop:n}
-%     \item[\texttt{:nn}:~] defines \cs{quark_if_recursion_tail_stop_do:nn}
-%     \item[\texttt{:nN}:~] defines \cs{quark_if_recursion_tail_break:nN}
-%     \item[\texttt{:N}:~]  defines \cs{quark_if_recursion_tail_stop:N}
-%     \item[\texttt{:Nn}:~] defines \cs{quark_if_recursion_tail_stop_do:Nn}
-%     \item[\texttt{:NN}:~] defines \cs{quark_if_recursion_tail_break:NN}
+%     \def\makelabel#1{\texttt{:#1}~}
+%     \item[n]  gives an analogue of \cs{quark_if_recursion_tail_stop:n}
+%     \item[nn] gives an analogue of \cs{quark_if_recursion_tail_stop_do:nn}
+%     \item[nN] gives an analogue of \cs{quark_if_recursion_tail_break:nN}
+%     \item[N]  gives an analogue of \cs{quark_if_recursion_tail_stop:N}
+%     \item[Nn] gives an analogue of \cs{quark_if_recursion_tail_stop_do:Nn}
+%     \item[NN] gives an analogue of \cs{quark_if_recursion_tail_break:NN}
 %   \end{description}
 %   Any other signature causes an error, as does a function without signature.
 %
 % \begin{macro}{\__kernel_quark_new_conditional:Nn}
-%   Similar to \cs{__kernel_quark_new_test:N}, but defines
-%   quark branching conditionals like \cs{quark_if_nil:nTF}
-%   using |#2| as the test quark, |#3| as the name-space to define
-%   auxiliaries, and |#4| is the list of conditional variants to define.
-%
-%   There are only two cases here:
+%   Similar to \cs{__kernel_quark_new_test:N}, but defines quark
+%   branching conditionals like \cs{quark_if_nil:nTF} that test for the
+%   quark \cs[no-index]{q__\meta{namespace}_\meta{name}}.
+%   The \meta{namespace} and \meta{name} are determined from the
+%   conditional~|#1|, which must take the rather rigid form
+%   \cs[no-index]{__\meta{namespace}_quark_if_\meta{name}:\meta{arg spec}}.
+%   There are only two cases for the \meta{arg spec} here:
 %   \begin{description}
-%     \item[\texttt{:n}:~] defines \cs[no-index]{quark_if_nil:n(TF)}
-%     \item[\texttt{:N}:~] defines \cs[no-index]{quark_if_nil:N(TF)}
+%     \def\makelabel#1{\texttt{:#1}~}
+%     \item[n] gives an analogue of \cs[no-index]{quark_if_nil:n(TF)}
+%     \item[N] gives an analogue of \cs[no-index]{quark_if_nil:N(TF)}
 %   \end{description}
 %   Any other signature causes an error, as does a function without signature.
 %