[latex3-commits] [git/LaTeX3-latex3-latex2e] ltpara: documentation update on \RawParEnd (6ad3289b)

[Frank Mittelbach]

Repository : https://github.com/latex3/latex2e
On branch  : ltpara
Link       : https://github.com/latex3/latex2e/commit/6ad3289b777c95264d999486fcde655e247018fe

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

commit 6ad3289b777c95264d999486fcde655e247018fe
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date:   Wed Apr 14 15:26:21 2021 +0200

    documentation update on \RawParEnd


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

6ad3289b777c95264d999486fcde655e247018fe
 base/ltpara.dtx | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

diff --git a/base/ltpara.dtx b/base/ltpara.dtx
index cc7b87b1..9f004a0e 100644
--- a/base/ltpara.dtx
+++ b/base/ltpara.dtx
@@ -376,7 +376,7 @@
 %    \item[\cs{@kernel at before@para at before}]
 %       For future extensions, not currently used by the kernel.
 %
-
+%
 %    \item[\cs{@kernel at after@para at after}]
 %       For future extensions, not currently used by the kernel.
 %
@@ -481,11 +481,18 @@
 %    in vertical mode and generate an error if found elsewhere.
 %
 %    To avoid issues a paragraph started by them should always be
-%    ended by \cs{RawParEnd} and not by
-%    \cs{par} as the latter will execute hooks which then have no
-%    counterpart at the beginning of the paragraph. It is the
-%    responsibility of the programmer to make sure that they are
-%    properly paired.
+%    ended by \cs{RawParEnd}\footnote{Technical note for those who
+%    know their \textit{\TeX book\/}: the \cs{RawParEnd} comand
+%    invokes the original \TeX{} engine definition of \cs{par} that
+%    (soley) triggers the paragraph builder in \TeX{} when found
+%    inside unrestricted horizontal mode and does nothing in other
+%    processing modes.}
+%    and not by \cs{par} (or a blank line), because the latter will execute
+%    hooks which then have no counterpart at the beginning of the
+%    paragraph. It is the responsibility of the programmer to make
+%    sure that they are properly paired. This also means that one
+%    should not put arbitrary user content between these commands if
+%    that content could contain stray \cs{par}s.
 %
 %    The \pkg{expl3} names for the functions are
 %    \cs{para_raw_indent:}, \cs{para_raw_indent:} and