[latex3-commits] [git/LaTeX3-latex3-latex3] main: Document boxes are compatible with LaTeXe, color-safe, and create groups (171f978f4)

[Bruno Le Floch]

Repository : https://github.com/latex3/latex3
On branch  : main
Link       : https://github.com/latex3/latex3/commit/171f978f49d468315545bb97c0c27721dbeeb4d2

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

commit 171f978f49d468315545bb97c0c27721dbeeb4d2
Author: Bruno Le Floch <blflatex at gmail.com>
Date:   Sat May 15 22:57:16 2021 +0200

    Document boxes are compatible with LaTeXe, color-safe, and create groups


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

171f978f49d468315545bb97c0c27721dbeeb4d2
 l3kernel/l3box.dtx | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/l3kernel/l3box.dtx b/l3kernel/l3box.dtx
index 2fdaae86d..2446a57f7 100644
--- a/l3kernel/l3box.dtx
+++ b/l3kernel/l3box.dtx
@@ -65,6 +65,16 @@
 % assigned during the construction of this box restores its value
 % afterwards.
 %
+% Box variables from \pkg{l3box} are compatible with those of \LaTeXe{}
+% and plain \TeX{} and can be used interchangeably.  The \pkg{l3box}
+% commands to construct boxes, such as \cs{hbox:n} or \cs{hbox_set:Nn},
+% are \enquote{color-safe}, meaning that
+% \begin{verbatim}
+% \hbox:n { \color_select:n { blue } Hello, } ~ world!
+% \end{verbatim}
+% will result in \enquote{Hello,} taking the color blue, but
+% \enquote{world!} remaining with the prevailing color outside the box.
+%
 % \section{Creating and initialising boxes}
 %
 % \begin{function}{\box_new:N, \box_new:c}