[latex3-commits] [git/LaTeX3-latex3-latex3] master: l3cctab documentation details about local vs global assignments (ac51f385a)

[Joseph Wright]

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

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

commit ac51f385a59c84820e40603c66979e7502daed4f
Author: Bruno Le Floch <bruno at le-floch.fr>
Date:   Fri Jun 26 21:58:27 2020 +0200

    l3cctab documentation details about local vs global assignments


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

ac51f385a59c84820e40603c66979e7502daed4f
 l3kernel/l3cctab.dtx | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/l3kernel/l3cctab.dtx b/l3kernel/l3cctab.dtx
index 864b21626..251db71de 100644
--- a/l3kernel/l3cctab.dtx
+++ b/l3kernel/l3cctab.dtx
@@ -71,18 +71,18 @@
 %     \cs{cctab_const:Nn} \meta{category code table} \Arg{category code set up}
 %   \end{syntax}
 %   Creates a new \meta{category code table} with the category code settings in
-%   force at the time the function is called, and applies the
-%   \meta{category code set up} on top of prevailing settings, then saves
-%   as a constant table.
+%   force at the time the function is called, and applies (in a group) the
+%   \meta{category code set up} on top of prevailing settings, then saves them
+%   globally as a constant table.
 % \end{function}
 %
 % \begin{function}{\cctab_gset:Nn,\cctab_gset:cn}
 %   \begin{syntax}
 %     \cs{cctab_gset:Nn} \meta{category code table} \Arg{category code set up}
 %   \end{syntax}
-%   Sets the \meta{category code table} to apply the category codes
-%   which apply when the prevailing régime is modified by the
-%   \meta{category code set up}. Thus within a standard code block
+%   Applies (in a group) the \meta{category code set up} on top of
+%   prevailing category code settings, then saves them globally in the
+%   \meta{category code table}. Thus within a standard code block
 %   the starting point will be the code applied by \cs{c_code_cctab}.
 %   The assignment of the table is global: the underlying primitive does
 %   not respect grouping.
@@ -94,7 +94,7 @@
 %   \begin{syntax}
 %     \cs{cctab_begin:N} \meta{category code table}
 %   \end{syntax}
-%   Switches the category codes in force to those stored in the
+%   Switches locally the category codes in force to those stored in the
 %   \meta{category code table}.  The prevailing codes before the
 %   function is called are added to a stack, for use with
 %   \cs{cctab_end:}. This function does not start a \TeX{} group.
@@ -105,13 +105,15 @@
 %     \cs{cctab_end:}
 %   \end{syntax}
 %   Ends the scope of a \meta{category code table} started using
-%   \cs{cctab_begin:N}, retuning the codes to those in force before
-%   the matching \cs{cctab_begin:N} was used.
+%   \cs{cctab_begin:N}, returning the codes to those in force before the
+%   matching \cs{cctab_begin:N} was used.  This must be used within the
+%   same \TeX{} group (and at the same \TeX{} group level) as the
+%   matching \cs{cctab_begin:N}.
 % \end{function}
 %
 % \begin{function}[added = 2020-05-19]{\cctab_select:N}
 %   \begin{syntax}
-%     \cs{cctab_select:N}\meta{category code table}
+%     \cs{cctab_select:N} \meta{category code table}
 %   \end{syntax}
 %   Selects the \meta{category code table} for the scope of the current
 %   group.
@@ -385,7 +387,7 @@
 %   Skipping these checks would result in an \enquote{Undefined control
 %   sequence} error for \cs{cctab_begin:N} with an undefined
 %   \meta{cctab~var}, and a \enquote{Missing font identifier} for an extra
-%   \cs{cctab_end:}.
+%   \cs{cctab_end:} (or another error in LuaTeX).
 %    \begin{macrocode}
 \cs_new_protected:Npn \cctab_begin:N #1
   { \@@_chk_if_valid:NT #1 { \@@_begin:N #1 } }