[latex3-commits] [latex3/latex2e] gh1234: documentation fix for #1234 (7d45cab9)

[github at latex-project.org]

Repository : https://github.com/latex3/latex2e
On branch  : gh1234
Link       : https://github.com/latex3/latex2e/commit/7d45cab927d63552aaa64136101c9ce0e78c3de1

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

commit 7d45cab927d63552aaa64136101c9ce0e78c3de1
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date:   Sat Mar 9 11:54:08 2024 +0100

    documentation fix for #1234


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

7d45cab927d63552aaa64136101c9ce0e78c3de1
 base/ltcmdhooks.dtx | 14 +++++++++++---
 base/lthooks.dtx    |  4 ++--
 2 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/base/ltcmdhooks.dtx b/base/ltcmdhooks.dtx
index bb071e62..a3c89b48 100644
--- a/base/ltcmdhooks.dtx
+++ b/base/ltcmdhooks.dtx
@@ -20,7 +20,7 @@
 %<*driver>
 % \fi
 \ProvidesFile{ltcmdhooks.dtx}
-             [2024/02/11 v1.0i LaTeX Kernel (Command hooks)]
+             [2024/03/09 v1.0i LaTeX Kernel (Command hooks)]
 % \iffalse
 %
 \documentclass{l3doc}
@@ -129,8 +129,8 @@
 %    \item
 %
 %      that code can be prepended or appended (i.e., added to the
-%      hooks) even if the command itself is not defined, because the
-%      defining package has not yet been loaded;
+%      hooks) even if the command itself is not (yet) defined, because the
+%      defining package has not been loaded at this point;
 %
 %    \item
 %
@@ -218,6 +218,14 @@
 % optional and mandatory arguments.  By adding code to the
 % \hook{cmd/section/after} hook, you get in the way of that scanning.
 %
+% In such a case, where it is known that a specific generic command
+% hook does not work if code is added to it, the package author can
+% add a \cs{DisableGenericHook}\footnote{Please use
+% \cs{DisableGenericHook} if at all, only on hooks that you
+% \enquote{own}, i.e., for commands your package or class defines and
+% not second guess whether or not hooks of other packages should get
+% disabled!} declaration to prevent this from happening in user
+% documents and thereby avoiding obscure errors.
 %
 %
 % \section{Package Author Interface}
diff --git a/base/lthooks.dtx b/base/lthooks.dtx
index ea337d30..7e02aa4f 100644
--- a/base/lthooks.dtx
+++ b/base/lthooks.dtx
@@ -32,7 +32,7 @@
 %<*driver>
 % \fi
 \ProvidesFile{lthooks.dtx}
-             [2024/02/11 v1.1h LaTeX Kernel (hooks)]
+             [2024/03/09 v1.1h LaTeX Kernel (hooks)]
 % \iffalse
 %
 \documentclass{l3doc}
@@ -233,9 +233,9 @@
 %    (e.g., one used in code with \cs{UseHook} or
 %    \cs{UseOneTimeHook}) without it being explicitly declared with
 %    \cs{NewHook}).
-%    This command undoes the effect of \cs{DisableGenericHook}.
 %    If the hook is already activated, this command does nothing.
 %
+%    Note that this command does not undo the effect of \cs{DisableGenericHook}.
 %    See section~\ref{sec:generic-hooks} for a discussion of when this
 %    declaration is appropriate.
 % \end{function}