[latex3-commits] [git/LaTeX3-latex3-latex3] master: Some doc rearrangements [ci skip] (797baf7)

Joseph Wright joseph.wright at morningstar2.co.uk
Mon Apr 2 19:54:56 CEST 2018


Repository : https://github.com/latex3/latex3
On branch  : master
Link       : https://github.com/latex3/latex3/commit/797baf70ecfc561ab350b25f831f5b7a1ed0e912

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

commit 797baf70ecfc561ab350b25f831f5b7a1ed0e912
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Mon Apr 2 18:54:56 2018 +0100

    Some doc rearrangements [ci skip]


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

797baf70ecfc561ab350b25f831f5b7a1ed0e912
 l3kernel/l3color-base.dtx |   34 ++++++++++++------------
 l3kernel/l3expan.dtx      |   14 +++++-----
 l3kernel/l3msg.dtx        |    2 +-
 l3kernel/l3prop.dtx       |   14 +++++-----
 l3kernel/l3seq.dtx        |   63 ++++++++++++++++++++-------------------------
 5 files changed, 59 insertions(+), 68 deletions(-)

diff --git a/l3kernel/l3color-base.dtx b/l3kernel/l3color-base.dtx
index 8294fd9..9436b39 100644
--- a/l3kernel/l3color-base.dtx
+++ b/l3kernel/l3color-base.dtx
@@ -76,10 +76,22 @@
 %   \cs{color_group_begin:} \ldots \cs{color_group_end:} group.
 % \end{function}
 %
-% \subsection{Internal functions}
+% \end{documentation}
+%
+% \begin{implementation}
+%
+% \section{\pkg{l3color-base} Implementation}
+%
+%    \begin{macrocode}
+%<*initex|package>
+%    \end{macrocode}
 %
-% \begin{variable}[added = 2017-06-15, updated = 2017-10-02]
-%   {\l__color_current_tl}
+%    \begin{macrocode}
+%<@@=color>
+%    \end{macrocode}
+%
+% \begin{variable}
+%   {\l_@@_current_tl}
 %   The color currently active for foreground (text, \emph{etc.}) material.
 %   This is stored in the form of a color model followed by one or more
 %   values. There are four pre-defined models, three of which take numerical
@@ -102,27 +114,13 @@
 %   number of data entries these require will depend on the number of
 %   colors to be mixed.
 %   \begin{texnote}
-%     The content of \cs{l__color_current_tl} is space-separated as
+%     The content of \cs{l_@@_current_tl} is space-separated as
 %     this allows it to be used directly in specials in many common cases.
 %     This internal representation is close to that used by the \texttt{dvips}
 %     program.
 %   \end{texnote}
 % \end{variable}
 %
-% \end{documentation}
-%
-% \begin{implementation}
-%
-% \section{\pkg{l3color-base} Implementation}
-%
-%    \begin{macrocode}
-%<*initex|package>
-%    \end{macrocode}
-%
-%    \begin{macrocode}
-%<@@=color>
-%    \end{macrocode}
-%
 % \begin{macro}{\color_group_begin:, \color_group_end:}
 %   Grouping for color is almost the same as using the basic \cs{group_begin:}
 %   and \cs{group_end:} functions.  However, in vertical mode the end-of-group
diff --git a/l3kernel/l3expan.dtx b/l3kernel/l3expan.dtx
index 871763e..6c6d5fe 100644
--- a/l3kernel/l3expan.dtx
+++ b/l3kernel/l3expan.dtx
@@ -797,13 +797,7 @@
 %   braces will not terminate the \texttt{f}-type expansion.
 % \end{function}
 %
-% \section{Internal functions and variables}
-%
-% \begin{variable}{\l__exp_internal_tl}
-%   The |\exp_| module has its private variable to temporarily store the
-%   result of |x|-type argument expansion. This is done to avoid interference
-%   with other functions using temporary variables.
-% \end{variable}
+% \section{Internal functions}
 %
 % \begin{function}{\::n, \::N, \::p, \::c, \::o, \::f, \::x, \::v, \::V, \:::}
 %   \begin{syntax}
@@ -828,6 +822,12 @@
 %<@@=exp>
 %    \end{macrocode}
 %
+% \begin{variable}{\l_@@_internal_tl}
+%   The |\exp_| module has its private variable to temporarily store the
+%   result of |x|-type argument expansion. This is done to avoid interference
+%   with other functions using temporary variables.
+% \end{variable}
+%
 % \begin{macro}{\exp_after:wN}
 % \begin{macro}{\exp_not:N}
 % \begin{macro}{\exp_not:n}
diff --git a/l3kernel/l3msg.dtx b/l3kernel/l3msg.dtx
index e4b0cba..5a0c65b 100644
--- a/l3kernel/l3msg.dtx
+++ b/l3kernel/l3msg.dtx
@@ -1148,7 +1148,7 @@
 %     \msg_show:nnxx   ,
 %     \msg_show:nnx
 %   }
-% \begin{macro}[aux]{\@@_show:n, \@@_show:w, \@@_show_dot:w, \@@_show:nn}
+% \begin{macro}{\@@_show:n, \@@_show:w, \@@_show_dot:w, \@@_show:nn}
 %   The \texttt{show} message type is used for \cs{seq_show:N} and
 %   similar complicated data structures.  Wrap the given text with a
 %   trailing dot (important later) then pass it to \cs{@@_show:n}.  If
diff --git a/l3kernel/l3prop.dtx b/l3kernel/l3prop.dtx
index f1daf6b..ea1fb04 100644
--- a/l3kernel/l3prop.dtx
+++ b/l3kernel/l3prop.dtx
@@ -474,14 +474,14 @@
 % (equal to \cs{scan_stop:}), and \cs{@@_pair:wn} can be used to map
 % through the property list.
 %
-% \begin{variable}{\s__prop}
+% \begin{variable}{\s_@@}
 %   The internal token used at the beginning of property lists.  This is
-%   also used after each \meta{key} (see \cs{__prop_pair:wn}).
+%   also used after each \meta{key} (see \cs{@@_pair:wn}).
 % \end{variable}
 %
-% \begin{variable}{\__prop_pair:wn}
+% \begin{variable}{\@@_pair:wn}
 %   \begin{syntax}
-%     \cs{__prop_pair:wn} \meta{key} \cs{s__prop} \Arg{item}
+%     \cs{@@_pair:wn} \meta{key} \cs{s_@@} \Arg{item}
 %   \end{syntax}
 %   The internal token used to begin each key--value pair in the
 %   property list.  If expanded outside of a mapping or manipulation
@@ -489,14 +489,14 @@
 %   set globally.
 % \end{variable}
 %
-% \begin{variable}{\l__prop_internal_tl}
+% \begin{variable}{\l_@@_internal_tl}
 %   Token list used to store new key--value pairs to be inserted by
 %   functions of the \cs{prop_put:Nnn} family.
 % \end{variable}
 %
-% \begin{function}[updated = 2013-01-08]{\__prop_split:NnTF}
+% \begin{function}[updated = 2013-01-08]{\@@_split:NnTF}
 %   \begin{syntax}
-%     \cs{__prop_split:NnTF} \meta{property list} \Arg{key} \Arg{true code} \Arg{false code}
+%     \cs{@@_split:NnTF} \meta{property list} \Arg{key} \Arg{true code} \Arg{false code}
 %   \end{syntax}
 %   Splits the \meta{property list} at the \meta{key}, giving three
 %   token lists: the \meta{extract} of \meta{property list} before the
diff --git a/l3kernel/l3seq.dtx b/l3kernel/l3seq.dtx
index 7001692..acb41c7 100644
--- a/l3kernel/l3seq.dtx
+++ b/l3kernel/l3seq.dtx
@@ -855,40 +855,6 @@
 %   Writes the entries in the \meta{sequence} in the log file.
 % \end{function}
 %
-% \section{Internal sequence functions}
-%
-% \begin{variable}{\s__seq}
-%   This scan mark (equal to \cs{scan_stop:}) marks the beginning of a
-%   sequence variable.
-% \end{variable}
-%
-% \begin{function}[EXP]{\__seq_item:n}
-%   \begin{syntax}
-%     \cs{__seq_item:n} \Arg{item}
-%   \end{syntax}
-%   The internal token used to begin each sequence entry. If expanded
-%   outside of a mapping or manipulation function, an error is
-%   raised. The definition should always be set globally.
-% \end{function}
-%
-% \begin{function}{\__seq_push_item_def:n, \__seq_push_item_def:x}
-%   \begin{syntax}
-%     \cs{__seq_push_item_def:n} \Arg{code}
-%   \end{syntax}
-%   Saves the definition of \cs{__seq_item:n} and redefines it to
-%   accept one parameter and expand to \meta{code}. This function
-%   should always be balanced by use of \cs{__seq_pop_item_def:}.
-% \end{function}
-%
-% \begin{function}{\__seq_pop_item_def:}
-%   \begin{syntax}
-%     \cs{__seq_pop_item_def:}
-%   \end{syntax}
-%   Restores the definition of \cs{__seq_item:n} most recently saved by
-%   \cs{__seq_push_item_def:n}. This function should always be used in
-%   a balanced pair with \cs{__seq_push_item_def:n}.
-% \end{function}
-%
 % \end{documentation}
 %
 % \begin{implementation}
@@ -913,7 +879,34 @@
 %   \meta{item_1} \cs{seq_elt_end:} \ldots \cs{seq_elt:w} \meta{item_n}
 %   \cs{seq_elt_end:}}.  This allowed rapid searching using a delimited
 % function, but was not suitable for items containing |{|, |}| and |#|
-% tokens, and also lead to the loss of surrounding braces around items.
+% tokens, and also lead to the loss of surrounding braces around items
+%
+% \begin{function}[EXP]{\@@_item:n}
+%   \begin{syntax}
+%     \cs{@@_item:n} \Arg{item}
+%   \end{syntax}
+%   The internal token used to begin each sequence entry. If expanded
+%   outside of a mapping or manipulation function, an error is
+%   raised. The definition should always be set globally.
+% \end{function}
+%
+% \begin{function}{\@@_push_item_def:n, \@@_push_item_def:x}
+%   \begin{syntax}
+%     \cs{@@_push_item_def:n} \Arg{code}
+%   \end{syntax}
+%   Saves the definition of \cs{@@_item:n} and redefines it to
+%   accept one parameter and expand to \meta{code}. This function
+%   should always be balanced by use of \cs{@@_pop_item_def:}.
+% \end{function}
+%
+% \begin{function}{\@@_pop_item_def:}
+%   \begin{syntax}
+%     \cs{@@_pop_item_def:}
+%   \end{syntax}
+%   Restores the definition of \cs{@@_item:n} most recently saved by
+%   \cs{@@_push_item_def:n}. This function should always be used in
+%   a balanced pair with \cs{@@_push_item_def:n}.
+% \end{function}
 %
 % \begin{variable}{\s_@@}
 %   The variable is defined in the \pkg{l3quark} module, loaded later.





More information about the latex3-commits mailing list