[latex3-commits] [git/LaTeX3-latex3-latex2e] develop: Document \hook_show:n and \hook_log:n (8f5ff550)

[PhelypeOleinik]

Repository : https://github.com/latex3/latex2e
On branch  : develop
Link       : https://github.com/latex3/latex2e/commit/8f5ff55038f54b2f1ccec8253489f9f91e60be65

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

commit 8f5ff55038f54b2f1ccec8253489f9f91e60be65
Author: PhelypeOleinik <phelype.oleinik at latex-project.org>
Date:   Fri Sep 11 06:38:18 2020 -0300

    Document \hook_show:n and \hook_log:n


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

8f5ff55038f54b2f1ccec8253489f9f91e60be65
 base/lthooks.dtx | 35 ++++++++++++++++++++++++++++++++---
 1 file changed, 32 insertions(+), 3 deletions(-)

diff --git a/base/lthooks.dtx b/base/lthooks.dtx
index 2aa1230a..17c3262a 100644
--- a/base/lthooks.dtx
+++ b/base/lthooks.dtx
@@ -351,8 +351,10 @@
 % \meta{label} throughout the sub-packages in order to avoid
 % that the labels change if you internally reorganize your code.
 %
-% Except for \cs{UseHook} and \cs{UseOneTimeHook} (and their \pkg{expl3}
-% interfaces \cs{hook_use:n} and \cs{hook_use_once:n}), all \meta{hook}
+% Except for \cs{UseHook}, \cs{UseOneTimeHook}, \cs{IfHookEmptyTF}, and
+% \cs{IfHookExistsTF} (and their \pkg{expl3} interfaces \cs{hook_use:n},
+% \cs{hook_use_once:n}, \cs{hook_if_empty:nTF}, and
+% \cs{hook_if_exist:nTF}), all \meta{hook}
 % and \meta{label} arguments are processed in the same way: first,
 % spaces are trimmed around the argument, then it is fully expanded
 % until only character tokens remain.  If the full expansion of the
@@ -628,7 +630,7 @@
 %    rule it is helpful to get some information about the code
 %    associated with a hook, its current order and the existing rules.
 %
-% \begin{function}{\ShowHook}
+% \begin{function}{\ShowHook,\LogHook}
 %   \begin{syntax}
 %     \cs{ShowHook} \Arg{hook}
 %   \end{syntax}
@@ -644,6 +646,10 @@
 %      any code executed on the next invocation only.
 %   \end{itemize}
 %
+%   \cs{LogHook} prints the information to the |.log| file, and
+%   \cs{ShowHook} prints them to the terminal/command window and starts
+%   \TeX's prompt (only if \cs{errorstopmode}) to wait for user action.
+%
 %    The \meta{hook} can be specified using the dot-syntax to denote
 %    the current package name. See section~\ref{sec:default-label}.
 % \end{function}
@@ -827,6 +833,29 @@
 %    A leading |.| is treated literally.
 % \end{function}
 %
+% \begin{function}{\hook_show:n,\hook_log:n}
+%   \begin{syntax}
+%     \cs{hook_show:n} \Arg{hook}
+%   \end{syntax}
+%   Displays information about the \meta{hook} such as
+%   \begin{itemize}
+%   \item
+%      the code chunks (and their labels) added to it,
+%   \item
+%      any rules set up to order them,
+%   \item
+%      the computed order in which the chunks are executed,
+%   \item
+%      any code executed on the next invocation only.
+%   \end{itemize}
+%
+%   \cs{hook_log:n} prints the information to the |.log| file, and
+%   \cs{hook_show:n} prints them to the terminal/command window and starts
+%   \TeX's prompt (only if \cs{errorstopmode}) to wait for user action.
+%
+%    The \meta{hook} can be specified using the dot-syntax to denote
+%    the current package name. See section~\ref{sec:default-label}.
+% \end{function}
 %
 % \begin{function}{\hook_debug_on:,\hook_debug_off:}
 %   \begin{syntax}