Skip to content

Commit

Permalink
Harmonise doc of variable mappings to document that assignments are l…
Browse files Browse the repository at this point in the history
…ocal
  • Loading branch information
Bruno Le Floch committed Nov 15, 2017
1 parent 26fc246 commit c74af68
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 35 deletions.
12 changes: 6 additions & 6 deletions l3kernel/l3clist.dtx
Expand Up @@ -400,13 +400,13 @@
% \begin{function}[updated = 2012-06-29]
% {\clist_map_variable:NNn, \clist_map_variable:cNn, \clist_map_variable:nNn}
% \begin{syntax}
% \cs{clist_map_variable:NNn} \meta{comma list} \meta{tl~var.} \Arg{function using tl~var.}
% \cs{clist_map_variable:NNn} \meta{comma list} \meta{variable} \Arg{code}
% \end{syntax}
% Stores each entry in the \meta{comma list} in turn in the
% \meta{tl~var.}\ and applies the \meta{function using tl~var.}
% The \meta{function} usually consists of code making use of
% the \meta{tl~var.}, but this is not enforced. The \meta{items}
% are returned from left to right.
% Stores each \meta{item} of the \meta{comma list} in turn in the
% (token list) \meta{variable} and applies the \meta{code}. The
% \meta{code} will usually make use of the \meta{variable}, but this
% is not enforced. The assignments to the \meta{variable} are local.
% The \meta{items} are returned from left to right.
% \end{function}
%
% \begin{function}[rEXP, updated = 2012-06-29]{\clist_map_break:}
Expand Down
13 changes: 6 additions & 7 deletions l3kernel/l3seq.dtx
Expand Up @@ -498,14 +498,13 @@
% \seq_map_variable:cNn, \seq_map_variable:ccn
% }
% \begin{syntax}
% \cs{seq_map_variable:NNn} \meta{sequence} \meta{tl~var.} \Arg{function using tl~var.}
% \cs{seq_map_variable:NNn} \meta{sequence} \meta{variable} \Arg{code}
% \end{syntax}
% Stores each entry in the \meta{sequence} in turn in the
% \meta{tl~var.}\ and applies the \meta{function using tl~var.}
% The \meta{function} will usually consist of code making use of
% the \meta{tl~var.}, but this is not enforced. The assignments to
% \meta{tl~var.} are local. The \meta{items}
% are returned from left to right.
% Stores each \meta{item} of the \meta{sequence} in turn in the (token
% list) \meta{variable} and applies the \meta{code}. The \meta{code}
% will usually make use of the \meta{variable}, but this is not
% enforced. The assignments to the \meta{variable} are local. The
% \meta{items} are returned from left to right.
% \end{function}
%
% \begin{function}[rEXP, updated = 2012-06-29]{\seq_map_break:}
Expand Down
26 changes: 13 additions & 13 deletions l3kernel/l3str.dtx
Expand Up @@ -455,26 +455,26 @@
% \begin{function}[added = 2017-11-14]
% {\str_map_variable:NNn, \str_map_variable:cNn}
% \begin{syntax}
% \cs{str_map_variable:NNn} \meta{str~var} \meta{variable} \Arg{function}
% \cs{str_map_variable:NNn} \meta{str~var} \meta{variable} \Arg{code}
% \end{syntax}
% Applies the \meta{function} to every \meta{character} in
% the \meta{str~var} including spaces.
% The \meta{function} should consist of code
% which receives the \meta{character} stored in the \meta{variable}.
% See also \cs{str_map_inline:Nn}.
% Stores each \meta{character} of the \meta{string} (including spaces)
% in turn in the (string or token list) \meta{variable} and applies
% the \meta{code}. The \meta{code} will usually make use of the
% \meta{variable}, but this is not enforced. The assignments to the
% \meta{variable} are local. See also \cs{str_map_inline:Nn}.
% \end{function}
%
% \begin{function}[added = 2017-11-14]
% {\str_map_variable:nNn}
% \begin{syntax}
% \cs{str_map_variable:nNn} \Arg{token list} \meta{variable} \Arg{function}
% \cs{str_map_variable:nNn} \Arg{token list} \meta{variable} \Arg{code}
% \end{syntax}
% Converts the \meta{token list} to a \meta{string} then
% applies the \meta{function} to every \meta{character} in the
% \meta{string} including spaces.
% The \meta{function} should consist of code
% which receives the \meta{character} stored in the \meta{variable}.
% See also \cs{str_map_inline:Nn}.
% Converts the \meta{token list} to a \meta{string} then stores each
% \meta{character} in the \meta{string} (including spaces) in turn in
% the (string or token list) \meta{variable} and applies the
% \meta{code}. The \meta{code} will usually make use of the
% \meta{variable}, but this is not enforced. The assignments to the
% \meta{variable} are local. See also \cs{str_map_inline:Nn}.
% \end{function}
%
% \begin{function}[added = 2017-10-08, rEXP]{\str_map_break:}
Expand Down
20 changes: 11 additions & 9 deletions l3kernel/l3tl.dtx
Expand Up @@ -540,21 +540,23 @@
% \begin{function}[updated = 2012-06-29]
% {\tl_map_variable:NNn, \tl_map_variable:cNn}
% \begin{syntax}
% \cs{tl_map_variable:NNn} \meta{tl~var} \meta{variable} \Arg{function}
% \cs{tl_map_variable:NNn} \meta{tl~var} \meta{variable} \Arg{code}
% \end{syntax}
% Applies the \meta{function} to every \meta{item} stored
% within the \meta{tl~var}. The \meta{function} should consist of code
% which receives the \meta{item} stored in the \meta{variable}.
% See also \cs{tl_map_inline:Nn}.
% Stores each \meta{item} of the \meta{tl~var} in turn in the (token
% list) \meta{variable} and applies the \meta{code}. The \meta{code}
% will usually make use of the \meta{variable}, but this is not
% enforced. The assignments to the \meta{variable} are local. See
% also \cs{tl_map_inline:Nn}.
% \end{function}
%
% \begin{function}[updated = 2012-06-29]{\tl_map_variable:nNn}
% \begin{syntax}
% \cs{tl_map_variable:nNn} \Arg{token list} \meta{variable} \Arg{function}
% \cs{tl_map_variable:nNn} \Arg{token list} \meta{variable} \Arg{code}
% \end{syntax}
% Applies the \meta{function} to every \meta{item} stored
% within the \meta{token list}. The \meta{function} should consist of code
% which receives the \meta{item} stored in the \meta{variable}.
% Stores each \meta{item} of the \meta{token list} in turn in the
% (token list) \meta{variable} and applies the \meta{code}. The
% \meta{code} will usually make use of the \meta{variable}, but this
% is not enforced. The assignments to the \meta{variable} are local.
% See also \cs{tl_map_inline:nn}.
% \end{function}
%
Expand Down

0 comments on commit c74af68

Please sign in to comment.