[latex3-commits] [git/LaTeX3-latex3-latex3] main: Document that boxes create groups (1a3fffc76)

[Bruno Le Floch]

Repository : https://github.com/latex3/latex3
On branch  : main
Link       : https://github.com/latex3/latex3/commit/1a3fffc76947e9c9fbaec47ad0a5bee2d5e92bf6

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

commit 1a3fffc76947e9c9fbaec47ad0a5bee2d5e92bf6
Author: Bruno Le Floch <blflatex at gmail.com>
Date:   Sat May 15 22:52:15 2021 +0200

    Document that boxes create groups


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

1a3fffc76947e9c9fbaec47ad0a5bee2d5e92bf6
 l3kernel/l3box.dtx | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/l3kernel/l3box.dtx b/l3kernel/l3box.dtx
index 1eb6848d8..2fdaae86d 100644
--- a/l3kernel/l3box.dtx
+++ b/l3kernel/l3box.dtx
@@ -49,9 +49,21 @@
 %
 % \begin{documentation}
 %
+% Box variables contain typeset material that can be inserted on the
+% page or in other boxes.  Their contents cannot be converted back to
+% lists of tokens.
 % There are three kinds of box operations: horizontal mode denoted
 % with prefix |\hbox_|, vertical mode with prefix |\vbox_|, and the
 % generic operations working in both modes with prefix |\box_|.
+% For instance, a new box variable containing the words \enquote{Hello,
+% world!} (in a horizontal box) can be obtained by the following code.
+% \begin{verbatim}
+% \box_new:N \l_hello_box
+% \hbox_set:Nn \l_hello_box { Hello, ~ world! }
+% \end{verbatim}
+% The argument is typeset inside a \TeX{} group so that any variables
+% assigned during the construction of this box restores its value
+% afterwards.
 %
 % \section{Creating and initialising boxes}
 %