[latex3-commits] [git/LaTeX3-latex3-latex3] main: Document \peek_remove_spaces:n (58d88e460)

[Joseph Wright]

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

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

commit 58d88e46046dd32b085e2557dac4c7a2619db9a3
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Tue Jan 11 19:34:14 2022 +0000

    Document \peek_remove_spaces:n


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

58d88e46046dd32b085e2557dac4c7a2619db9a3
 l3kernel/l3token.dtx | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/l3kernel/l3token.dtx b/l3kernel/l3token.dtx
index 7867caceb..c9af667ca 100644
--- a/l3kernel/l3token.dtx
+++ b/l3kernel/l3token.dtx
@@ -974,6 +974,17 @@
 %   appropriate to the result of the test).
 % \end{function}
 %
+% \begin{function}[added = 2018-10-01]{\peek_remove_spaces:n}
+%   \begin{syntax}
+%     \cs{peek_remove_spaces:n} \Arg{code}
+%   \end{syntax}
+%   Peeks ahead and detect if the following token is a space (category code
+%   $10$ and character code $32$). If so, removes the token and checks the
+%   next token. Once a non-space token is found, the \meta{code} will be
+%   inserted into the input stream. Typically this will contain a \texttt{peek}
+%   operation, but this is not required.
+% \end{function}
+%
 % \begin{function}[added = 2022-01-10]{\peek_remove_filler:n}
 %   \begin{syntax}
 %     \cs{peek_remove_filler:n} \Arg{code}