[latex3-commits] [git/LaTeX3-latex3-latex2e] copyedits-chris: some cleanup and some answers (ff19e8f2)

Frank Mittelbach frank.mittelbach at latex-project.org
Fri Oct 15 00:13:45 CEST 2021 

Repository : https://github.com/latex3/latex2e
On branch  : copyedits-chris
Link       : https://github.com/latex3/latex2e/commit/ff19e8f26ead8efde98eb66aab7fdf8bc8c2eee0

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

commit ff19e8f26ead8efde98eb66aab7fdf8bc8c2eee0
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date:   Fri Oct 15 00:13:45 2021 +0200

    some cleanup and some answers


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

ff19e8f26ead8efde98eb66aab7fdf8bc8c2eee0
 base/doc/ltnews34.tex | 39 ++++++++++++++++++---------------------
 1 file changed, 18 insertions(+), 21 deletions(-)

diff --git a/base/doc/ltnews34.tex b/base/doc/ltnews34.tex
index de10a04c..3ad5948e 100644
--- a/base/doc/ltnews34.tex
+++ b/base/doc/ltnews34.tex
@@ -195,20 +195,18 @@ activate the generic hook by using \cs{ActivateGenericHook}.\footnote{Note
   that in the previous release we offered \cs{ProvideHook} as a means
   to achieve this effect, but the name was badly chosen so we decided
   to deprecate it and now offer \cs{ActivateGenericHook} instead.}
-%%  CCC because that is what it is meant for.}
 
 Assuming
 that you don't know all the different hook names up front, it will
 remain the task of the users of your package to activate the hook
 themselves before adding code to it. For example, Babel offers hooks
-such as \texttt{babel/afterextras/\meta{language}} 
-%%  CCC  OR ???
+such as \hook{babel/\meta{language}/afterextras} 
 that enable a user
 to add language specific declarations to these \enquote{extras}.  One can then write
 \begin{verbatim}
 \ActivateGenericHook
-          {babel/afterextras/ngerman}
-\AddToHook{babel/afterextras/ngerman}
+          {babel/ngerman/afterextras}
+\AddToHook{babel/ngerman/afterextras}
           {\color{blue}}
 \end{verbatim}
 after which all German words would be colored blue in the text.
@@ -338,18 +336,19 @@ The implementation has now been changed, so that
 labels that already exist in a hook: it will display a warning if there is no such code label.
 %%  CCC meaning?? :  
 %% When this is used across packages
+%% FMi: meaning that if package A want's to get rid of what package B might have done it should use a ``void'' relation, but if you are within your own code and have set up something and at a later point want to remove it again then  RemoveFromHook is fine (and the right solution).
 For removing code from a hook, the
 \texttt{voids} relation should preferably be used instead: this relation is
-non-destructive (meaning it can be later reverted by using another relation), and so
+non-destructive (meaning it can be later reverted by using another relation), and
+%%FMi it is independent of pkg order but that has nothing to do with previous part, so no ``so''
+%%so
 it is truly independent of package loading order. 
 %% CCC so it should be preferred.
 %
 \githubissue{625}
 
 
-%% \subsection{???}
 
-%% \githubissue{000}
 
 
 
@@ -375,6 +374,7 @@ now added \cs{PackageNote} and \cs{PackageNoteNoLine}, that identify
 themselves as \enquote{informational}, but that still go to the terminal and
 not only to the transcript.
 % CCC ?? And: say what the NoLine means?
+%% FMi That exists for 30 year for \PackageWarningNoLine \PackageInfoNoLine and the like so don't think it is needed. But in case you don't know it... it doesn't report the line at which the warning/info/note was discovered.
 Similar commands exist for classes and so there too we have 
 added the two new commands \cs{ClassNote} and \cs{ClassNoteNoLine}.
 %
@@ -386,6 +386,7 @@ added the two new commands \cs{ClassNote} and \cs{ClassNoteNoLine}.
 The commands \cs{counterwithout} and \cs{counterwithin} each now has
 an additional optional argument, similar to the command 
 %% CCC so it becomes a drop-in replacement for
+%% FMi the implicit suggestion is to use the kernel method
  \cs{numberwithin} from \pkg{amsmath}.  
 This optional argument 
 specifies the format of the counter, such as \cs{roman}, 
@@ -488,15 +489,13 @@ and the same happens for each math alphabet, (such as \cs{mathbf}) that
 gets used anywhere in the document. Up to now, these math
 alphabet allocations were permanent, even if they were 
 used only once;
-%% CCC and then never; 
 the result was that in complex documents you
 could easily run out of available math font groups. 
 The only remedy for this was to
 define your own math version, which is a complicated and cumbersome process.
 
-This situation has has now been improved by the introduction of a new counter
+This situation has now been improved by the introduction of a new counter
 \texttt{localmathalphabets}, which governs how many of the math group
-%%CCC remaining 
 slots are assigned only locally when a new math alphabet (and a new
 math group) is needed.  
 %
@@ -514,9 +513,7 @@ whether used or not.
 %
 \githubissue{676}
 
-%% \subsection{???}
 
-%% \githubissue{000}
 
 
 
@@ -534,6 +531,7 @@ checked only for \cs{foo}.
 %% CCC removed since not understood.
 %% this reflects the fact that historically the code was 
 %% designed around the target of an entirely new format.
+%%FMi what Joseph meant is that the code was initiall written for a new standalone format initially and so not faithfully done error recovery the way 2e did it.
 
 The behavior of \cs{NewDocumentEnvironment}
 now aligns with that of \cs{newenvironment}, except that it gives distinct errors
@@ -575,6 +573,7 @@ first three arguments and it relied on the fourth being empty (and thus
 doing no harm). But this assumption is not always correct, e.g., if
 you use \pkg{hyperref} and then remove 
 %%CCC What is "it" here:
+%%FMi it is hyperref ... but I agree the writing is not clear (you use hyperref then drop it so that aux file is left with an extra argument which is next time no longer use so blows up
 it from the preamble.
 %
 So now the code picks up all four arguments, saving the 
@@ -591,9 +590,7 @@ the callback handler indicates removal of the entire math list.
 %
 \githubissue{644}
 
-%% \subsection{???}
 
-%% \githubissue{000}
 
 
 
@@ -601,8 +598,10 @@ the callback handler indicates removal of the entire math list.
 
 \section{Bug fixes}
 
-\subsection{Replicate argument processors for all\\ %%CCC ?? 
-    embellishments in command declarations}
+\subsection[Replicate argument processors for all
+     embellishments in command declarations]
+           {Replicate argument processors for all \\ %%CCC ?? 
+     \mbox{}\qquad embellishments in command declarations}
 
 There was a bug in \pkg{ltcmd} (formerly \pkg{xparse}) that caused
 commands to misbehave if they were defined with embellishments and
@@ -679,17 +678,15 @@ so that the use of \texttt{\#} here no longer generates an error.
 %
 \githubissue{665}
 
-%% \subsection{???}
 
-%% \githubissue{000}
 
 
 
 \section{Changes to packages in the \pkg{graphics} category}
 
 
-\subsection{New key, for alt text}
-A new key, \texttt{alt}, has been added to \verb|\includegraphics| to support the addition of descriptive text that is important for accessibility.
+\subsection{\pkg{graphicx}: New key, for alt text}
+A new key, \texttt{alt}, has been added to \cs{includegraphics} to support the addition of descriptive text that is important for accessibility.
 This key is unused by default; it can be deployed by extension packages and it will provide useful support for other future possibilities.
 %
 \githubissue{651}

More information about the latex3-commits mailing list.