[latex3-commits] [git/LaTeX3-latex3-latex2e] hotfix/gh441: Typos, missing docs, and clearer tests (d55eced8)

[PhelypeOleinik]

Repository : https://github.com/latex3/latex2e
On branch  : hotfix/gh441
Link       : https://github.com/latex3/latex2e/commit/d55eced8986b260a03b0c4227202358fa1b200fb

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

commit d55eced8986b260a03b0c4227202358fa1b200fb
Author: PhelypeOleinik <phelype.oleinik at latex-project.org>
Date:   Fri Dec 18 10:51:12 2020 -0300

    Typos, missing docs, and clearer tests


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

d55eced8986b260a03b0c4227202358fa1b200fb
 base/lthooks.dtx                       | 12 +++++++-----
 base/testfiles-lthooks/lthooks-026.lvt |  8 ++++----
 base/testfiles-lthooks/lthooks-026.tlg | 20 ++++++++++----------
 3 files changed, 21 insertions(+), 19 deletions(-)

diff --git a/base/lthooks.dtx b/base/lthooks.dtx
index e6f0f3c2..f1a84828 100644
--- a/base/lthooks.dtx
+++ b/base/lthooks.dtx
@@ -527,8 +527,8 @@
 %
 % The default assumption is that code added to hooks by different
 % packages are independent and the order in which they are executed is
-% irrelevant. While this is true in many case it is  obviously false
-% in many others.
+% irrelevant. While this is true in many cases it is obviously false
+% in others.
 %
 % Before the hook management system was introduced
 % packages had to take elaborate precaution to determine of some other
@@ -877,7 +877,6 @@
 %
 %    The \meta{hook} \emph{cannot} be specified using the dot-syntax.
 %    A leading |.| is treated literally.
-%    \fmi{better L3 name?}
 % \end{function}
 %
 % \begin{function}{\hook_gput_code:nnn}
@@ -1880,7 +1879,10 @@
 % \begin{macro}{\@@_tl_gput_left:Nn,\@@_tl_gput_left:No}
 % \begin{macro}{\@@_tl_gclear:N,\@@_tl_gclear:c}
 % \begin{macro}{\@@_tl_gset_eq:NN}
-%   Scan mark used for delimited arguments.
+%   Private copies of a few \pkg{expl3} functions.  \pkg{l3debug} will
+%   only add debugging to the public names, not to these copies, so we
+%   don't have to use \cs{debug_suspend:} and \cs{debug_resume:}
+%   everywhere.
 %    \begin{macrocode}
 \cs_new_eq:NN \@@_tl_set:Nn \tl_set:Nn
 \cs_generate_variant:Nn \@@_tl_set:Nn { cn, cx }
@@ -2603,7 +2605,7 @@
 %    was added to \cs[no-index]{@@_toplevel~\meta{hook}} (granted that
 %    an empty code could be interpreted as that, but then it differs in
 %    behaviour from other labels, in which an empty chunk is still valid
-%    for removal).  Besides, it doesn't make much (if any) sense to
+%    for removal).  Besides, it doesn't make much (if any) sense for
 %    packages to remove |top-level| code.  So here the chunk is just
 %    cleared unconditionally.
 %    \begin{macrocode}
diff --git a/base/testfiles-lthooks/lthooks-026.lvt b/base/testfiles-lthooks/lthooks-026.lvt
index a623b0f1..27953038 100644
--- a/base/testfiles-lthooks/lthooks-026.lvt
+++ b/base/testfiles-lthooks/lthooks-026.lvt
@@ -10,10 +10,10 @@
 \START
 
 
-\BeforeBeginEnvironment{quote}{\typeout{quote before}}% env/quote/before
-\AtBeginEnvironment{quote}{\typeout{quote begin}}%      env/quote/begin
-\AtEndEnvironment{quote}{\typeout{quote end}}%          env/quote/end
-\AfterEndEnvironment{quote}{\typeout{quote after}}%     env/quote/after
+\BeforeBeginEnvironment{quote}{\typeout{quote before (top-level)}}% env/quote/before
+\AtBeginEnvironment{quote}{\typeout{quote begin (top-level)}}%      env/quote/begin
+\AtEndEnvironment{quote}{\typeout{quote end (top-level)}}%          env/quote/end
+\AfterEndEnvironment{quote}{\typeout{quote after (top-level)}}%     env/quote/after
 
 \BeforeBeginEnvironment[foo]{quote}{\typeout{quote before 2}}% env/quote/before
 \AtBeginEnvironment[bar]{quote}{\typeout{quote begin 2}}%      env/quote/begin
diff --git a/base/testfiles-lthooks/lthooks-026.tlg b/base/testfiles-lthooks/lthooks-026.tlg
index 060b4675..f1272e6f 100644
--- a/base/testfiles-lthooks/lthooks-026.tlg
+++ b/base/testfiles-lthooks/lthooks-026.tlg
@@ -4,7 +4,7 @@ Don't change this file in any respect.
 > Code chunks:
 >     bar -> \typeout {quote begin 2}
 > Document-level (top-level) code (executed last):
->     -> \typeout {quote begin}
+>     -> \typeout {quote begin (top-level)}
 > Extra code for next invocation:
 >     ---
 > Rules:
@@ -27,16 +27,16 @@ LaTeX Font Info:    ... okay on input line ....
 LaTeX Font Info:    Checking defaults for U/cmr/m/n on input line ....
 LaTeX Font Info:    ... okay on input line ....
 quote before 2
-quote before
+quote before (top-level)
 quote begin 2
-quote begin
-quote end
-quote after
+quote begin (top-level)
+quote end (top-level)
+quote after (top-level)
 -> The hook 'env/quote/after':
 > Code chunks:
 >     foobar -> \typeout {quote after 2}
 > Document-level (top-level) code (executed first):
->     -> \typeout {quote after}
+>     -> \typeout {quote after (top-level)}
 > Extra code for next invocation:
 >     ---
 > Rules:
@@ -48,12 +48,12 @@ env/quote/begin is not reversed
 env/quote/end is not reversed
 env/quote/after is reversed
 quote before 2
-quote before
+quote before (top-level)
 quote begin 2
-quote begin
+quote begin (top-level)
 quote end 2
-quote end
-quote after
+quote end (top-level)
+quote after (top-level)
 quote after 2
 [1
 ] (lthooks-026.aux)