[latex3-commits] [git/LaTeX3-latex3-latex2e] develop: documentation cleanup (7047673a)
Frank Mittelbach
frank.mittelbach at latex-project.org
Sun Aug 30 23:53:41 CEST 2020
Repository : https://github.com/latex3/latex2e
On branch : develop
Link : https://github.com/latex3/latex2e/commit/7047673a5e9a683937fa00992e138059599246e2
>---------------------------------------------------------------
commit 7047673a5e9a683937fa00992e138059599246e2
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date: Sun Aug 30 23:53:41 2020 +0200
documentation cleanup
>---------------------------------------------------------------
7047673a5e9a683937fa00992e138059599246e2
base/ltfilehook.dtx | 17 +++++++----------
base/lthooks.dtx | 8 ++++----
base/ltshipout.dtx | 22 +++++++++-------------
3 files changed, 20 insertions(+), 27 deletions(-)
diff --git a/base/ltfilehook.dtx b/base/ltfilehook.dtx
index 45f8f9fc..ee284182 100644
--- a/base/ltfilehook.dtx
+++ b/base/ltfilehook.dtx
@@ -32,7 +32,7 @@
%
% \begin{macrocode}
\providecommand\ltfilehookversion{v1.0a}
-\providecommand\ltfilehookdate{2020/08/27}
+\providecommand\ltfilehookdate{2020/08/30}
% \end{macrocode}
%
%<*driver>
@@ -131,7 +131,7 @@
% comes first) so that the \texttt{before} and \texttt{after}
% hooks nest properly, which is important if any of them involve
% grouping (e.g., contain environments, for example).
-% furthermore both hooks are reversed hooks to support correct
+% Furthermore both hooks are reversed hooks to support correct
% nesting of different packages add code to both
% \texttt{/before} and \texttt{/after} hooks.
%
@@ -151,16 +151,13 @@
% \>\cs{UseHook}\marg{\hook{file/after}}
% \end{tabbing}
%
-% \fmi{With a higher-level interface that doesn't matter, but it
-% is a bit weird, if you use \cs{AddToHook} or \cs{hook_gput:nnn}
-% directly, so I guess that has to be done differently!}
-%
% The file hooks only refer to the file by its name and extension,
% so the \meta{file name} should be the file name as it is on the
% filesystem with extension (if any) and without paths. Different
-% from \cs{input} and similar commands, for hooks the \texttt{.tex}
-% extension is not assumed, so \texttt{.tex} files must also be given
-% with their extension.
+% from \cs{input} and similar commands, the \texttt{.tex}
+% extension is not assumed in hook \meta{file name}, so \texttt{.tex}
+% files must be specified
+% with their extension to be recognized.
% Files within subfolders should also be addressed by their name and
% extension only.
%
@@ -308,7 +305,7 @@
%
% \item[\texttt{include/before}, \texttt{include/before/\meta{name}}]
%
-% These hooks are executed one after another after the initial
+% These hooks are executed (in that order) after the initial
% \cs{clearpage} and after \texttt{.aux} file is changed to use
% \texttt{\meta{name}.aux}, but before the
% \texttt{\meta{name}.tex} file is loaded. In other words they are executed
diff --git a/base/lthooks.dtx b/base/lthooks.dtx
index 894f4e21..2412697a 100644
--- a/base/lthooks.dtx
+++ b/base/lthooks.dtx
@@ -32,7 +32,7 @@
%
% \begin{macrocode}
\def\lthooksversion{v1.0a}
-\def\lthooksdate{2020/08/27}
+\def\lthooksdate{2020/08/30}
% \end{macrocode}
%
%<*driver>
@@ -1159,18 +1159,18 @@
%
% \item[\hook{env/\meta{env}/end}]
%
-% This is executed as part of \cs{end} directly in front of the
+% This hook is executed as part of \cs{end} directly in front of the
% code specific to the end of the environment (e.g., the third
% argument of \cs{newenvironment}).
%
% \item[\hook{env/\meta{env}/after}]
%
-% This is executed as part of \cs{end} after the
+% This hook is executed as part of \cs{end} after the
% code specific to the environment end and after the environment
% group has ended.
% Its scope is therefore not restricted by the environment.
%
-% This hook is implemented as a reversed hook so if two packages
+% The hook is implemented as a reversed hook so if two packages
% add code to \hook{env/\meta{env}/before} and to
% \hook{env/\meta{env}/after} they can add surrounding
% environments and the order of closing them happens in the
diff --git a/base/ltshipout.dtx b/base/ltshipout.dtx
index 992e3972..5c178d1f 100644
--- a/base/ltshipout.dtx
+++ b/base/ltshipout.dtx
@@ -32,7 +32,7 @@
%
% \begin{macrocode}
\providecommand\ltshipoutversion{v1.0a}
-\providecommand\ltshipoutdate{2020/08/25}
+\providecommand\ltshipoutdate{2020/08/30}
% \end{macrocode}
%
%<*driver>
@@ -159,10 +159,6 @@
% vertical coordinate values would normally be
% negative.
%
-% \fmi{Again, mainly \pkg{atbegshi} compatibility. Not
-% sure it is best to have to always use negative
-% coordinates.}
-%
% Technically this is implemented by adding a zero-sized
% \cs{hbox} as the very first item into the \cs{ShipoutBox}
% containing that \texttt{picture} environment. Thus the rest of
@@ -186,14 +182,12 @@
% \item[\hook{shipout/firstpage}]
%
% The material from this hook is executed only once at the very
-% beginning of the first output page. It should only contain
-% \cs{special} commands needed to direct post processors
-% handling the \texttt{.dvi} or \texttt{.pdf} output.\fmi{not
-% sure it has to be that restrictive.}
+% beginning of the first output page that is shipped out (i.e.,
+% not discarded at the last minute). It should only contain
+% \cs{special} or similar commands needed to direct post processors
+% handling the \texttt{.dvi} or \texttt{.pdf} output.\footnotemark
%
-% In \LaTeXe{} that was already existing but implemented as a box
-% register \cs{@begindvibox}.
-% \fmi{drop or at least mark the obsolete code in latex.ltx}
+% ^^A \fmi{not sure it has to be that restrictive.}
%
%
% \item[\hook{shipout/lastpage}]
@@ -208,7 +202,9 @@
% placement sorted out.
%
% \end{description}
-% \end{variable}
+% \end{variable}\footnotetext{In
+% \LaTeXe{} that was already existing but implemented as a box
+% register \cs{@begindvibox}.}
%
% As mentioned above the hook \hook{shipout/before} is executed
% first and can manipulate the prepared shipout box stored in
More information about the latex3-commits
mailing list.