[latex3-commits] [git/LaTeX3-latex3-mathtools] master: Documentation update, fixes issue #38 (cbb104f)

[daleif]

Repository : https://github.com/latex3/mathtools
On branch  : master
Link       : https://github.com/latex3/mathtools/commit/cbb104fc03021bf47c4e6b1af3bdfb3ef4cc2eb9

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

commit cbb104fc03021bf47c4e6b1af3bdfb3ef4cc2eb9
Author: daleif <daleif at math.au.dk>
Date:   Mon Mar 14 12:22:17 2022 +0100

    Documentation update, fixes issue #38


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

cbb104fc03021bf47c4e6b1af3bdfb3ef4cc2eb9
 ANNOUNCEMENT  |  4 ++++
 mathtools.dtx | 17 +++++++++--------
 2 files changed, 13 insertions(+), 8 deletions(-)

diff --git a/ANNOUNCEMENT b/ANNOUNCEMENT
index a87b9b0..d2ebc37 100644
--- a/ANNOUNCEMENT
+++ b/ANNOUNCEMENT
@@ -1,5 +1,9 @@
 Announcement release 2022/02/07
 
+For mathtools.dtx v1.29
+
+* In section `Special mathtools options` clearified when `gathered` of pure amsmath might give a warning. (#38)
+
 For mathtools.dtx v1.28a:
 
 * fixed year typo in \ProvidesPackage
diff --git a/mathtools.dtx b/mathtools.dtx
index 3ddbf3e..2faf661 100644
--- a/mathtools.dtx
+++ b/mathtools.dtx
@@ -427,7 +427,7 @@ colorlinks,
 %  \begin{verbatim}
 %  \[
 %      \begin{gathered}
-%        [p] = 100 \\
+%        [t] = 100 \\
 %        [v] = 200
 %      \end{gathered}
 %  \]
@@ -439,15 +439,16 @@ colorlinks,
 %        [v] = 200
 %      \end{gathered}
 %  \]
-%  Yes, the \texttt{[p]} has been gobbled without any warning
-%  whatsoever.\footnote{\pkg{amsmath} thought the \texttt[p] was an
-%  optional argument, checked if it was \texttt{t} or \texttt{b} and
-%  when both tests failed, assumed it was a \texttt{c}.} This is
-%  hardly what you'd expect as an end user, as the desired output was
-%  probably something like this instead:
+%  Yes, the \texttt{[t]} has been gobbled without warning! Note, with
+%  modern \pkg{amsmath} \verb|\begin{gathered}[x]| will eat \verb|[x]|
+%    and \emph{issue a warning unless} \texttt{x} is \texttt{t},
+%    \texttt{b} or \texttt{c}.\footnote{Older \pkg{amsmath} will
+%    silently gobble the argument.}  This is hardly what you'd expect
+%    as an end user, as the desired output was probably something like
+%    this instead:
 %  \[
 %      \begin{gathered}[c]
-%        [p] = 100 \\
+%        [t] = 100 \\
 %        [v] = 200
 %      \end{gathered}
 %  \]