summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/l3kernel/l3box.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/l3kernel/l3box.dtx')
-rw-r--r--Master/texmf-dist/source/latex/l3kernel/l3box.dtx22
1 files changed, 13 insertions, 9 deletions
diff --git a/Master/texmf-dist/source/latex/l3kernel/l3box.dtx b/Master/texmf-dist/source/latex/l3kernel/l3box.dtx
index ef4a9b2d763..281c910e1ce 100644
--- a/Master/texmf-dist/source/latex/l3kernel/l3box.dtx
+++ b/Master/texmf-dist/source/latex/l3kernel/l3box.dtx
@@ -41,7 +41,7 @@
% }^^A
% }
%
-% \date{Released 2019-01-12}
+% \date{Released 2019-01-13}
%
% \maketitle
%
@@ -133,7 +133,8 @@
% \cs{box_use:N} \meta{box}
% \end{syntax}
% Inserts the current content of the \meta{box} onto the current
-% list for typesetting.
+% list for typesetting. An error is raised if the variable does
+% not exist or if it is invalid.
% \begin{texnote}
% This is the \TeX{} primitive \tn{copy}.
% \end{texnote}
@@ -144,7 +145,10 @@
% \cs{box_use_drop:N} \meta{box}
% \end{syntax}
% Inserts the current content of the \meta{box} onto the current
-% list for typesetting. The \meta{box} is then cleared at the group level the
+% list for typesetting. An error is raised if the variable does
+% not exist or if it is invalid.
+%
+% The \meta{box} is then cleared at the group level the
% box was set at, \emph{i.e.}~the current content is \enquote{dropped} entirely.
% For example, with
% \begin{verbatim}
@@ -158,13 +162,13 @@
% \group_end:
% \box_show:N \l_tmpa_box
% \end{verbatim}
-% the first use of |\box_show:N| will show an entirely cleared (void) box, and the
+% the first use of \cs{box_show:N} will show an entirely cleared (void) box, and the
% second will show the letter |A| in the box.
%
% This function is useful as boxes can contain an open-ended amount of material. As
% such, they can have a significant memory impact on \TeX{}. At the same time, it is
% often the case that once a box has been inserted, it is no longer needed at all.
-% Using |\box_use_drop:N| in these circumstances therefore offers improved memory
+% Using \cs{box_use_drop:N} in these circumstances therefore offers improved memory
% use and performance. It should therefore be preferred over \cs{box_use:N} where
% it is clear that the content is no longer needed in the variable.
% \begin{texnote}
@@ -181,8 +185,8 @@
% such that its reference point is displaced horizontally by the given
% \meta{dimexpr} from the reference point for typesetting, to the right
% or left as appropriate. The \meta{box function} should be
-% a box operation such as |\box_use:N \<box>| or a \enquote{raw}
-% box specification such as |\vbox:n { xyz }|.
+% a box operation such as \cs{box_use:N} |\<box>| or a \enquote{raw}
+% box specification such as \cs{vbox:n} |{ xyz }|.
% \end{function}
%
% \begin{function}{\box_move_up:nn, \box_move_down:nn}
@@ -194,8 +198,8 @@
% such that its reference point is displaced vertically by the given
% \meta{dimexpr} from the reference point for typesetting, up
% or down as appropriate. The \meta{box function} should be
-% a box operation such as |\box_use:N \<box>| or a \enquote{raw}
-% box specification such as |\vbox:n { xyz }|.
+% a box operation such as \cs{box_use:N} |\<box>| or a \enquote{raw}
+% box specification such as \cs{vbox:n} |{ xyz }|.
% \end{function}
%
% \section{Measuring and setting box dimensions}