[latex3-commits] [git/LaTeX3-latex3-latex3] main: Document how \tl_rescan:nn differs from the \scantokens primitive [ci skip] (e360029f3)

[Bruno Le Floch]

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

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

commit e360029f30d13e4bf9edb1ee7002fc5e3e226045
Author: Bruno Le Floch <blflatex at gmail.com>
Date:   Sat May 22 16:19:49 2021 +0200

    Document how \tl_rescan:nn differs from the \scantokens primitive [ci skip]


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

e360029f30d13e4bf9edb1ee7002fc5e3e226045
 l3kernel/l3tl.dtx | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/l3kernel/l3tl.dtx b/l3kernel/l3tl.dtx
index 141745d68..7624e3f4a 100644
--- a/l3kernel/l3tl.dtx
+++ b/l3kernel/l3tl.dtx
@@ -350,6 +350,11 @@
 %     Otherwise, spaces (and tabs) are retained at both ends of the
 %     single-line string, as if it appeared in the middle of a line
 %     read from a file.
+%
+%     Contrarily to the \tn{scantokens} primitive, \cs{tl_rescan:nn}
+%     tokenizes the whole string in the same category code regime rather
+%     than one token at a time, so that directives such as \tn{verb}
+%     that rely on changing category codes will not function properly.
 %   \end{texnote}
 % \end{function}
 %