[latex3-commits] [l3svn] r6915 - Rephrase l3flag doc due to removal of \flag_set_trap:nn

[noreply at latex-project.org]

Author: bruno
Date: 2017-02-13 23:50:20 +0100 (Mon, 13 Feb 2017)
New Revision: 6915

Modified:
   trunk/l3experimental/l3str/l3flag.dtx
Log:
Rephrase l3flag doc due to removal of \flag_set_trap:nn

There used to be a way to change what happens upon \flag_raise:n.
Since that was used nowhere I dropped it but forgot to update some
doc.


Modified: trunk/l3experimental/l3str/l3flag.dtx
===================================================================
--- trunk/l3experimental/l3str/l3flag.dtx	2017-02-13 21:48:16 UTC (rev 6914)
+++ trunk/l3experimental/l3str/l3flag.dtx	2017-02-13 22:50:20 UTC (rev 6915)
@@ -70,15 +70,14 @@
 %
 % \begin{documentation}
 %
-% Flags are the only data-type on which \TeX{} can perform
-% assignments in expansion-only contexts. This module is meant mostly
-% for kernel use: in almost all cases, booleans or integers should be
-% preferred to flags, because they are faster.
+% Flags are the only data-type that can be modified in expansion-only
+% contexts. This module is meant mostly for kernel use: in almost all
+% cases, booleans or integers should be preferred to flags because they
+% are very significantly faster.
 %
 % A flag can hold any non-negative value, which we call its
 % \meta{height}. In expansion-only contexts, a flag can only be
-% \enquote{raised}: this normally increases the \meta{height} by $1$,
-% but can be configured by defining specific traps. The \meta{height}
+% \enquote{raised}: this increases the \meta{height} by $1$. The \meta{height}
 % can also be queried expandably. However, decreasing it, or setting it
 % to zero requires non-expandable assignments.
 %
@@ -159,11 +158,7 @@
 %   \begin{syntax}
 %     \cs{flag_raise:n} \Arg{flag name}
 %   \end{syntax}
-%   The \meta{flag}'s trap is performed, taking the current height as
-%   its argument. The default behaviour is to increase the \meta{flag}'s
-%   height by $1$ locally. This function is expandable, as long as the
-%   trap is expandable (the default trap is expandable, despite being an
-%   assignment).
+%   The \meta{flag}'s height is increased by $1$ locally.
 % \end{function}
 %
 % \end{documentation}
@@ -256,8 +251,8 @@
 % \subsection{Expandable flag commands}
 %
 % \begin{macro}[EXP, pTF]{\flag_if_exist:n}
-%   A flag exist if the corresponding trap \cs{@@_trap_\meta{flag
-%       name}:n} is defined.
+%   A flag exist if the corresponding trap \cs[no-index]{flag \meta{flag
+%   name}:n} is defined.
 %    \begin{macrocode}
 \prg_new_conditional:Npnn \flag_if_exist:n #1 { p , T , F , TF }
   {
@@ -268,7 +263,7 @@
 % \end{macro}
 %
 % \begin{macro}[EXP, pTF]{\flag_if_raised:n}
-%   Test if the flag is non-zero, by checking the |_0| control sequence.
+%   Test if the flag is non-zero, by checking the |0| control sequence.
 %    \begin{macrocode}
 \prg_new_conditional:Npnn \flag_if_raised:n #1 { p , T , F , TF }
   {