[latex3-commits] [git/LaTeX3-latex3-latex3] main: Document that TeX ignores ~ at the start of a line (fix #125) (eea61d046)

[Bruno Le Floch]

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

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

commit eea61d04668b501ad6c6ef6df9b6fe7eeea6480c
Author: Bruno Le Floch <blflatex at gmail.com>
Date:   Sun Apr 25 09:55:13 2021 +0200

    Document that TeX ignores ~ at the start of a line (fix #125)
    
    I put the info as a texnote in the documentation of \ExplSyntaxOn
    in l3bootstrap since this is the only place where we say that ~ can
    be used to insert a space.


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

eea61d04668b501ad6c6ef6df9b6fe7eeea6480c
 l3kernel/l3bootstrap.dtx | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/l3kernel/l3bootstrap.dtx b/l3kernel/l3bootstrap.dtx
index 1539cd48f..831a060ae 100644
--- a/l3kernel/l3bootstrap.dtx
+++ b/l3kernel/l3bootstrap.dtx
@@ -63,11 +63,18 @@
 %     \cs{ExplSyntaxOn} \meta{code} \cs{ExplSyntaxOff}
 %   \end{syntax}
 %   The \cs{ExplSyntaxOn} function switches to a category code
-%   r\'{e}gime in which spaces are ignored and in which the colon (|:|)
+%   regime in which spaces and new lines are ignored, and in which the colon (|:|)
 %   and underscore (|_|) are treated as \enquote{letters}, thus allowing
 %   access to the names of code functions and variables. Within this
 %   environment, |~| is used to input a space. The \cs{ExplSyntaxOff}
-%   reverts to the document category code r\'{e}gime.
+%   reverts to the document category code regime.
+%   \begin{texnote}
+%     Spaces introduced by~|~| behave much in the same way as normal
+%     space characters in the standard category code regime: they are
+%     ignored after a control word or at the start of a line, and
+%     multiple consecutive~|~| are equivalent to a single one.  However,
+%     |~|~is \emph{not} ignored at the end of a line.
+%   \end{texnote}
 % \end{function}
 %
 % \begin{function}[updated = 2017-03-19]