[latex3-commits] [latex3/latex3] main: Document that peek functions cannot be used within a peek mapping [ci skip] (caa2648a6)

[github at latex-project.org]

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

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

commit caa2648a67f6188e2ae62b671f50b16d1f8e36c7
Author: Bruno Le Floch <blflatex at gmail.com>
Date:   Sun Feb 18 12:17:27 2024 +0100

    Document that peek functions cannot be used within a peek mapping [ci skip]


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

caa2648a67f6188e2ae62b671f50b16d1f8e36c7
 l3kernel/l3token.dtx | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/l3kernel/l3token.dtx b/l3kernel/l3token.dtx
index 0a26e815e..a5a225ab8 100644
--- a/l3kernel/l3token.dtx
+++ b/l3kernel/l3token.dtx
@@ -1005,6 +1005,10 @@
 %   effect after the loop.  Within the code, \cs{l_peek_token} is set
 %   equal (as a token, not a token list) to the token under
 %   consideration.
+%
+%   Peek functions cannot be used within this mapping function (nor
+%   other mapping functions) since the input stream contains trailing
+%   material necessary for the functioning of the loop.
 %   \begin{texnote}
 %     In case the input stream has not yet been tokenized (converted
 %     from characters to tokens), characters are tokenized one by one as