[latex3-commits] [git/LaTeX3-latex3-latex3] morechk: improve doc around checking for :c variants (703f5e4)

[Will Robertson]

Repository : https://github.com/latex3/latex3
On branch  : morechk
Link       : https://github.com/latex3/latex3/commit/703f5e4762b2933896206c6d84afc51bdd7e8401

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

commit 703f5e4762b2933896206c6d84afc51bdd7e8401
Author: Will Robertson <wspr81 at gmail.com>
Date:   Wed Jan 16 14:47:12 2019 +1030

    improve doc around checking for :c variants


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

703f5e4762b2933896206c6d84afc51bdd7e8401
 l3kernel/l3box.dtx  |   16 ++++++++++++----
 l3kernel/l3int.dtx  |    8 ++++++--
 l3kernel/l3skip.dtx |   24 ++++++++++++++++++------
 3 files changed, 36 insertions(+), 12 deletions(-)

diff --git a/l3kernel/l3box.dtx b/l3kernel/l3box.dtx
index 90ce6e9..687dd24 100644
--- a/l3kernel/l3box.dtx
+++ b/l3kernel/l3box.dtx
@@ -135,8 +135,12 @@
 %     \cs{box_use:N} \meta{box}
 %   \end{syntax}
 %   Inserts the current content of the \meta{box} onto the current
-%   list for typesetting. An error is raised if the variable does
-%   not exist or if it is invalid.
+%   list for typesetting.
+%
+%   For \cs{box_use:c}, if the \texttt{check-declarations} option is in effect,
+%   an error is raised if the variable does not exist or if it is invalid.
+%   For \cs{box_use:N}, no checking is performed and lower-level errors will result
+%   if invalid or non-existent variables are used.
 %   \begin{texnote}
 %     This is the \TeX{} primitive \tn{copy}.
 %   \end{texnote}
@@ -147,8 +151,12 @@
 %     \cs{box_use_drop:N} \meta{box}
 %   \end{syntax}
 %   Inserts the current content of the \meta{box} onto the current
-%   list for typesetting. An error is raised if the variable does
-%   not exist or if it is invalid.
+%   list for typesetting.
+%
+%   For \cs{box_use_drop:c}, if the \texttt{check-declarations} option is in effect,
+%   an error is raised if the variable does not exist or if it is invalid.
+%   For \cs{box_use_drop:N}, no checking is performed and lower-level errors will result
+%   if invalid or non-existent variables are used.
 %
 %   The \meta{box} is then cleared at the group level the
 %   box was set at, \emph{i.e.}~the current content is \enquote{dropped} entirely.
diff --git a/l3kernel/l3int.dtx b/l3kernel/l3int.dtx
index 6e5a05d..8108772 100644
--- a/l3kernel/l3int.dtx
+++ b/l3kernel/l3int.dtx
@@ -275,10 +275,14 @@
 %     \cs{int_use:N} \meta{integer}
 %   \end{syntax}
 %   Recovers the content of an \meta{integer} and places it directly
-%   in the input stream. An error is raised if the variable does
-%   not exist or if it is invalid. Can be omitted in places where an
+%   in the input stream. Can be omitted in places where an
 %   \meta{integer} is required (such as in the first and third arguments
 %   of \cs{int_compare:nNnTF}).
+%
+%   For \cs{int_use:c}, if the \texttt{check-declarations} option is in effect,
+%   an error is raised if the variable does not exist or if it is invalid.
+%   For \cs{int_use:N}, no checking is performed and lower-level errors will result
+%   if invalid or non-existent variables are used.
 %   \begin{texnote}
 %     \cs{int_use:N} is the \TeX{} primitive \tn{the}: this is one of
 %     several \LaTeX3 names for this primitive.
diff --git a/l3kernel/l3skip.dtx b/l3kernel/l3skip.dtx
index 4f6fc7e..8bae30f 100644
--- a/l3kernel/l3skip.dtx
+++ b/l3kernel/l3skip.dtx
@@ -458,10 +458,14 @@
 %     \cs{dim_use:N} \meta{dimension}
 %   \end{syntax}
 %   Recovers the content of a \meta{dimension} and places it directly
-%   in the input stream. An error is raised if the variable does
-%   not exist or if it is invalid. Can be omitted in places where a
+%   in the input stream.
+%   Can be omitted in places where a
 %   \meta{dimension} is required (such as in the argument of
 %   \cs{dim_eval:n}).
+%   For \cs{dim_use:c}, if the \texttt{check-declarations} option is in effect,
+%   an error is raised if the variable does not exist or if it is invalid.
+%   For \cs{dim_use:N}, no checking is performed and lower-level errors will result
+%   if invalid or non-existent variables are used.
 %   \begin{texnote}
 %     \cs{dim_use:N} is the \TeX{} primitive \tn{the}: this is one of
 %     several \LaTeX3 names for this primitive.
@@ -746,10 +750,14 @@
 %     \cs{skip_use:N} \meta{skip}
 %   \end{syntax}
 %   Recovers the content of a \meta{skip} and places it directly
-%   in the input stream. An error is raised if the variable does
-%   not exist or if it is invalid. Can be omitted in places where a
+%   in the input stream. Can be omitted in places where a
 %   \meta{dimension} or \meta{skip} is required (such as in the argument of
 %   \cs{skip_eval:n}).
+%
+%   For \cs{skip_use:c}, if the \texttt{check-declarations} option is in effect,
+%   an error is raised if the variable does not exist or if it is invalid.
+%   For \cs{skip_use:N}, no checking is performed and lower-level errors will result
+%   if invalid or non-existent variables are used.
 %   \begin{texnote}
 %     \cs{skip_use:N} is the \TeX{} primitive \tn{the}: this is one of
 %     several \LaTeX3 names for this primitive.
@@ -960,10 +968,14 @@
 %     \cs{muskip_use:N} \meta{muskip}
 %   \end{syntax}
 %   Recovers the content of a \meta{skip} and places it directly
-%   in the input stream. An error is raised if the variable does
-%   not exist or if it is invalid. Can be omitted in places where a
+%   in the input stream. Can be omitted in places where a
 %   \meta{dimension} is required (such as in the argument of
 %   \cs{muskip_eval:n}).
+%
+%   For \cs{int_use:c}, if the \texttt{check-declarations} option is in effect,
+%   an error is raised if the variable does not exist or if it is invalid.
+%   For \cs{int_use:N}, no checking is performed and lower-level errors will result
+%   if invalid or non-existent variables are used.
 %   \begin{texnote}
 %     \cs{muskip_use:N} is the \TeX{} primitive \tn{the}: this is one of
 %     several \LaTeX3 names for this primitive.