[latex3-commits] [latex3/latex3] main: Document \endlinechar function in cctab modules (fixes #1156) (a63fa9a00)

[github at latex-project.org]

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

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

commit a63fa9a00f67d97daf83e8acfd74e413dab3f630
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Fri May 26 10:48:13 2023 +0100

    Document \endlinechar function in cctab modules (fixes #1156)


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

a63fa9a00f67d97daf83e8acfd74e413dab3f630
 l3kernel/l3cctab.dtx | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/l3kernel/l3cctab.dtx b/l3kernel/l3cctab.dtx
index 2cbe46be1..c99fd37b6 100644
--- a/l3kernel/l3cctab.dtx
+++ b/l3kernel/l3cctab.dtx
@@ -52,7 +52,9 @@
 % A category code table enables rapid switching of all category codes in
 % one operation. For \LuaTeX{}, this is possible over the entire Unicode
 % range. For other engines, only the $8$-bit range ($0$--$255$) is covered by
-% such tables.
+% such tables. The implementation of category code tables in \pkg{expl3}
+% also saves and restores the \TeX{} \tn{endlinechar} primitive value, meaning
+% they could be used for example to implement \cs{ExplSyntaxOn}.
 %
 % \section{Creating and initialising category code tables}
 %
@@ -146,14 +148,15 @@
 % \begin{variable}[updated = 2020-07-10]{\c_code_cctab}
 %   Category code table for the \pkg{expl3} code environment; this does
 %   \emph{not} include \texttt{@}, which is retained as an \enquote{other}
-%   character.
+%   character.  Sets the \tn{endlinechar} value to $32$ (a space).
 % \end{variable}
 %
 % \begin{variable}[updated = 2020-07-08]{\c_document_cctab}
 %   Category code table for a standard \LaTeX{} document, as set by the \LaTeX{}
 %   kernel. In particular, the upper-half of the $8$-bit range will be set to
 %   \enquote{active} with \pdfTeX{} \emph{only}. No \pkg{babel} shorthands
-%   will be activated.
+%   will be activated.  Sets the \tn{endlinechar} value to $13$ (normal
+%   line ending).
 % \end{variable}
 %
 % \begin{variable}[updated = 2020-07-02]{\c_initex_cctab}
@@ -162,13 +165,13 @@
 %
 % \begin{variable}[updated = 2020-07-02]{\c_other_cctab}
 %   Category code table where all characters have category code $12$
-%   (other).
+%   (other). Sets the \tn{endlinechar} value to $-1$.
 % \end{variable}
 %
 % \begin{variable}[updated = 2020-07-02]{\c_str_cctab}
 %   Category code table where all characters have category code $12$
 %   (other) with the exception of spaces, which have category code
-%   $10$ (space).
+%   $10$ (space).  Sets the \tn{endlinechar} value to $-1$.
 % \end{variable}
 %
 % \end{documentation}