[latex3-commits] [git/LaTeX3-latex3-mathtools] master: added note about \eqref, fixes issue #33 (58e7e88)

[daleif]

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

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

commit 58e7e887026eac2e06694db1852d53cb560195c3
Author: daleif <daleif at math.au.dk>
Date:   Thu Jan 27 13:57:24 2022 +0100

    added note about \eqref, fixes issue #33


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

58e7e887026eac2e06694db1852d53cb560195c3
 mathtools.dtx | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/mathtools.dtx b/mathtools.dtx
index 18f6593..dcfd794 100644
--- a/mathtools.dtx
+++ b/mathtools.dtx
@@ -907,6 +907,13 @@ colorlinks,
 %    \SpecialKeyIndex{showmanualtags}$\key{showmanualtags}=\texttt{true}\vert\texttt{false}$\\
 %    \SpecialUsageIndex{\refeq}\cs{refeq}\marg{label}
 %  \end{codesyntax}
+%  First of, one should always use \cs{eqref} when referring to
+%  equation numbers. When \opt{showonlyrefs} is true, we monitor
+%  \cs{eqref}\marg{label}, and those used will get an equation number,
+%  whereas those not used will not. Note: We do \emph{not} monitor the
+%  normal \cs{ref} command! See the follow paragraph for situations
+%  for what to do when \cs{eqref} cannot be used to refer to the equation. 
+% 
 %  An equation where the tag is produced with a manual \cs{tag*}
 %  shouldn't be referenced with the normal \cs{eqref} because that
 %  would format it according to the current tag format. Using just