[latex3-commits] [latex3/latex2e] docu-fixes-after-merge: some late copyedits (7fca803b)

[github at latex-project.org]

Repository : https://github.com/latex3/latex2e
On branch  : docu-fixes-after-merge
Link       : https://github.com/latex3/latex2e/commit/7fca803b8a420cc0ebb827b96a76e81e44afe24e

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

commit 7fca803b8a420cc0ebb827b96a76e81e44afe24e
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date:   Fri Sep 6 15:33:28 2024 +0200

    some late copyedits


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

7fca803b8a420cc0ebb827b96a76e81e44afe24e
 required/latex-lab/latex-lab-block.dtx | 44 ++++++++++++++++++----------------
 1 file changed, 23 insertions(+), 21 deletions(-)

diff --git a/required/latex-lab/latex-lab-block.dtx b/required/latex-lab/latex-lab-block.dtx
index 9c8f0e56..c9f66370 100644
--- a/required/latex-lab/latex-lab-block.dtx
+++ b/required/latex-lab/latex-lab-block.dtx
@@ -1774,12 +1774,13 @@
       \legacy_if_gset_false:n { @inlabel }
     }
 %    \end{macrocode}
-%    In we are ending a list environment and haven't seen any
+%    If we are ending a list environment and we have not seen any
 %    \cs{item}, i.e., \texttt{@newlist} is still true, we raise an
-%    error. In pure a ``displayblock'' scenario \texttt{@newlist} will be
-%    always false, but if such an environment appears inside an outer
-%    list the code could still be triggered and that is undesirable
-%    (as it will be detected at the wrong point and later again). We
+%    error. In basic a ``displayblock'' scenario \texttt{@newlist} will
+%    always be false, but if such an environment appears inside an outer
+%    list then \cs{noitemerr} could still be triggered and that is undesirable
+%    (as the missing item will be detected at the wrong point and again later,
+%    during the outer list processing). We
 %    therefore run it only if the current environment is a list.
 %  \changes{v0.8q}{2024/09/03}{Raise a \cs{@noitemerr} if appropriate}
 %    \begin{macrocode}
@@ -1849,7 +1850,7 @@
 %
 %
 %  \begin{macro}{\@@_if_list:T}
-%    This needs some redesigning, as there is no good test for \enquote{is
+%    The following code may need some redesigning, as there is no good test for \enquote{is
 %    this environment a \enquote{list} that has \cs{item}s}. For now
 %    this here does the trick well enough.\fmi{revisit}
 %  \changes{v0.8q}{2024/09/03}{Provide a test for: Am I in a list?}
@@ -2299,21 +2300,23 @@
     }
 %    \end{macrocode}
 %    Finally, we signal that we are at the start of a new list (which
-%    effects how the first \cs{item} is handled and how \cs{par}
+%    affects how the first \cs{item} is handled and how \cs{par}
 %    commands are interpreted.
 %    \begin{macrocode}
     \legacy_if_gset_true:n { @newlist }
 %    \end{macrocode}
 %    If we encounter horizontal material before the first \cs{item} we
 %    do want a \cs{@noitemerr} straight away, because afterwards we
-%    end up with tagging structure faults  and the cause is the
+%    end up with tagging structure faults whose cause is the
 %    missing \cs{item}. So we setup up \cs{@@_item_everypar:} to test
-%    for this. When the first \cs{item} is encountered this is then
-%    reset. This is only relevant for vertical lists, if we have
-%    inline lists one would need to test for somethingg else to
-%    identify that there is horizontal material between list start and
-%    the first \cs{item}, maybe some \cs{spacefactor} trick could be
-%    used then.\fmi{Think about a better implementation at some point.}
+%    for this; when the first \cs{item} is encountered this will get
+%    reset. This is only relevant for vertical lists, when dealing with
+%    inline lists one would need to test for something else to
+%    identify that there is horizontal material between the start of the list and
+%    the first \cs{item} (maybe some \cs{spacefactor} trick could be
+%    used then, or the material is boxed first and the width is
+%    inspected as suggested by Joseph).\fmi{Think about a better
+%    implementation at some point.}
 %  \changes{v0.8q}{2024/09/02}{}
 %    \begin{macrocode}
     \cs_set_eq:NN \@@_item_everypar: \@@_item_everypar_first:
@@ -2563,7 +2566,7 @@
 % \begin{macro}{\@@_item_everypar:, \@@_item_everypar_std:, \@@_item_everypar_first:}
 %    The \cs{@@_item_everypar:} command is executed as part of \hook{para/begin}
 %    but most of the time does nothing, i.e., it has the following
-%    default definition outside of lists and most of the time within lists.
+%    default definition outside of lists (and most of the time within lists).
 %    \begin{macrocode}
 \cs_new_eq:NN \@@_item_everypar: \prg_do_nothing:
 %    \end{macrocode}
@@ -2577,7 +2580,7 @@
 %    \texttt{@inlabel} to make a decision.
 %
 %    By the end of the day both should probably move into the kernel
-%    hook instead or into sockets really.
+%    hook instead or, better, into sockets.
 %    \begin{macrocode}
 \DeclareHookRule{para/begin}{items}{after}{tagpdf}
 %    \end{macrocode}
@@ -2631,7 +2634,7 @@
 }
 %    \end{macrocode}
 %
-%    This is the setting for \cs{@@_item_everypar:} before the first
+%    This is the definition of \cs{@@_item_everypar:} before the first
 %    \cs{item} is encountered.
 %  \changes{v0.8q}{2024/09/02}{Call \cs{@noitemerr} if hmode is
 %    started before the first item}
@@ -4092,7 +4095,7 @@
 %    Finally, at the list end we have to close the open
 %    \texttt{LBody}, \texttt{LI}, \texttt{L}, and possibly a
 %    \struct{text} if the last item ends with a list.
-%    However, if the user forgot to add an \cs{item} there is no
+%    However, if the user forgot to add an \cs{item} then there will be no
 %    \texttt{LI} and \texttt{LBody} open, so we check for the status
 %    of \texttt{@newlist}. The corresponding no-item error was
 %    generated earlier outside the tagging code.
@@ -4110,9 +4113,8 @@
 %    \begin{macrocode}
 \cs_set:Npn \@@_list_end: {
 %    \end{macrocode}
-%    If \texttt{@newlist} is true (ie when we have an error or warning
-%    situation) there is not much to close. If \verb=<L></L>= is not
-%    valid syntax we could add an empty \verb=<LI>= at this point instead.\fmi{check}
+%    If \texttt{@newlist} is true (i.e., when we have an error or warning
+%    situation) there is not much to close.
 %    \begin{macrocode}
   \legacy_if:nF { @newlist }
     {