[latex3-commits] [git/LaTeX3-latex3-latex3] master: Misc comment fixups (spelling, clarifications) [ci skip] (f4abd8f)

[Bruno Le Floch]

Repository : https://github.com/latex3/latex3
On branch  : master
Link       : https://github.com/latex3/latex3/commit/f4abd8fbf16a586df5688094e31b6888cca662a8

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

commit f4abd8fbf16a586df5688094e31b6888cca662a8
Author: Bruno Le Floch <bruno at le-floch.fr>
Date:   Thu Mar 29 22:08:45 2018 -0400

    Misc comment fixups (spelling, clarifications) [ci skip]


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

f4abd8fbf16a586df5688094e31b6888cca662a8
 l3kernel/expl3.dtx            |    7 ++++---
 l3kernel/l3fp-aux.dtx         |    6 +++---
 l3kernel/l3prg.dtx            |    9 +++++++--
 l3kernel/l3token.dtx          |    3 ++-
 l3trial/l3bigint/l3bigint.dtx |    2 +-
 5 files changed, 17 insertions(+), 10 deletions(-)

diff --git a/l3kernel/expl3.dtx b/l3kernel/expl3.dtx
index f001b8c..a3435b5 100644
--- a/l3kernel/expl3.dtx
+++ b/l3kernel/expl3.dtx
@@ -920,15 +920,16 @@
 % which are constructed using macros as the underlying storage system. The
 % \texttt{check-declarations} option enables checking for all variable
 % assignments, issuing an error if any variables are assigned without being
-% initialised.  See also the function \cs{debug_check_declarations_on:}.
+% initialised.
+% See also \cs{debug_on:n} \texttt{\{check-declarations\}} for finer control.
 %
 % \DescribeOption{log-functions}
 % The \texttt{log-functions} option is used to enable recording of every new
 % function name in the \texttt{.log} file. This is useful for debugging
 % purposes, as it means that there is a complete list of all functions
 % created by each module loaded (with the exceptions of a very small number
-% required by the bootstrap code for \LaTeX3).  See also the function
-% \cs{debug_log_functions_on:}.
+% required by the bootstrap code for \LaTeX3).
+% See also \cs{debug_on:n} \texttt{\{log-functions\}} for finer control.
 %
 % \DescribeOption{enable-debug}
 % To allow more localized checking and logging than provided by
diff --git a/l3kernel/l3fp-aux.dtx b/l3kernel/l3fp-aux.dtx
index 462b22f..296fc81 100644
--- a/l3kernel/l3fp-aux.dtx
+++ b/l3kernel/l3fp-aux.dtx
@@ -1243,9 +1243,9 @@
 %
 % \begin{macro}{\@@_str_if_eq_x:nn}
 %   A private version of the low-level string comparison function. As
-%   the nature of the is restricted and as speed is of the essence,
-%   this version does not seek to deal with |#| tokens (\emph{cf.}
-%   No \pkg{l3sys} or \pkg{l3luaex} just yet so we have to define in terms of
+%   the nature of the arguments is restricted and as speed is of the essence,
+%   this version does not seek to deal with |#| tokens.
+%   No \pkg{l3sys} or \pkg{l3luatex} just yet so we have to define in terms of
 %   primitives.
 %    \begin{macrocode}
 \cs_new:Npn \@@_str_if_eq_x:nn #1#2 { \pdftex_strcmp:D {#1} {#2} }
diff --git a/l3kernel/l3prg.dtx b/l3kernel/l3prg.dtx
index b16c3c1..ca1dc89 100644
--- a/l3kernel/l3prg.dtx
+++ b/l3kernel/l3prg.dtx
@@ -685,8 +685,13 @@
 %   stream the \meta{user code} after the \meta{ending code} for the
 %   loop.  The function breaks loops, inserting their \meta{ending
 %   code}, until reaching a loop with the same \meta{type} as its
-%   first argument.  This \cs[no-index]{\meta{type}_map_break:} argument is
-%   simply used as a recognizable marker for the \meta{type}.
+%   first argument.  This \cs[no-index]{\meta{type}_map_break:} argument
+%   must be defined; it is simply used as a recognizable marker for the \meta{type}.
+%
+%   For types with mappings defined in the kernel,
+%   \cs[no-index]{\meta{type}_map_break:} and \cs[no-index]{\meta{type}_map_break:n}
+%   are defined as \cs{prg_map_break:Nn} \cs[no-index]{\meta{type}_map_break:} |{}|
+%   and the same with |{}| omitted.
 % \end{function}
 %
 % \subsection{Simple mappings}
diff --git a/l3kernel/l3token.dtx b/l3kernel/l3token.dtx
index 40bc54e..e4956b3 100644
--- a/l3kernel/l3token.dtx
+++ b/l3kernel/l3token.dtx
@@ -1104,7 +1104,8 @@
 %   \cs{char_generate:nn} but omits various sanity tests. In particular, this
 %   means it is used in certain places where engine variations need to be
 %   accounted for by the kernel.  The \meta{catcode} must give an explicit
-%   integer when expanded (and must not absorb a space for instance).
+%   integer when expanded (and must not absorb a space for instance, nor
+%   be an integer variable).
 % \end{function}
 %
 % \end{documentation}
diff --git a/l3trial/l3bigint/l3bigint.dtx b/l3trial/l3bigint/l3bigint.dtx
index af2eb4a..e6f3730 100644
--- a/l3trial/l3bigint/l3bigint.dtx
+++ b/l3trial/l3bigint/l3bigint.dtx
@@ -622,7 +622,7 @@
 % packages.
 %
 % \begin{macro}{\@@_str_cmp_x:nn}
-%   Af in \pkg{l3fp}, we use a private string comparison set up here. Note
+%   As in \pkg{l3fp}, we use a private string comparison set up here. Note
 %   that in this case we do need non-zero return values: no other string
 %   comparison requires this.
 %    \begin{macrocode}