[latex3-commits] [git/LaTeX3-latex3-latex2e] master: more comments from Barbara/Lars (199789e)

[David Carlisle]

Repository : https://github.com/latex3/latex2e
On branch  : master
Link       : https://github.com/latex3/latex2e/commit/199789ec23959b927ff5b1e4d1286ac0a45d2e4c

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

commit 199789ec23959b927ff5b1e4d1286ac0a45d2e4c
Author: David Carlisle <d.p.carlisle at gmail.com>
Date:   Wed Apr 4 23:01:14 2018 +0100

    more comments from Barbara/Lars


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

199789ec23959b927ff5b1e4d1286ac0a45d2e4c
 required/amsmath/amsldoc.tex |   43 +++++++++++++++++++++++++++++++-----------
 1 file changed, 32 insertions(+), 11 deletions(-)

diff --git a/required/amsmath/amsldoc.tex b/required/amsmath/amsldoc.tex
index a9d4d43..9c36e79 100644
--- a/required/amsmath/amsldoc.tex
+++ b/required/amsmath/amsldoc.tex
@@ -884,7 +884,8 @@ an optional\index{options!positioning of \texttt{-ed} environments}
 |[b]|\index{b option@\texttt{b} (bottom) option} or the default
 |[c]|\index{c option@\texttt{c} (center) option}
 argument to specify vertical
-positioning.  For maximum interoperability, do not insert a space\index{options!space before \texttt{[}}
+positioning.  For maximum interoperability, do not insert a
+space\index{options!space before \texttt{[}}
 or line break\index{line break} before the option.  See
 also the note on page~\pageref{breaknote} regarding page breaking
 within the \texttt{-ed} environments.
@@ -924,11 +925,13 @@ displays. The environments of the \nipkg{amsmath} package try hard to
 avoid overprinting an equation number on the equation contents, if
 necessary moving the number down or up to a separate line. Difficulties
 in accurately calculating the profile of an equation can occasionally
-result in number movement that doesn't look right. There is a
-\cn{raisetag} command provided to adjust the vertical position of the
+result in number movement that doesn't look right.
+A \cn{raisetag} command is provided to adjust the vertical position of the
 current equation number, if it has been shifted away from its normal
 position. To move a particular number up by six points, write
-|\raisetag{6pt}|. This kind of adjustment is fine tuning like line
+|\raisetag{6pt}|. (At the end of a display, this also shifts up the
+text following the display.)
+This kind of adjustment is fine tuning like line
 breaks and page breaks, and should therefore be left undone until your
 document is nearly finalized, or you may end up redoing the fine tuning
 several times to keep up with changing document contents.
@@ -1006,8 +1009,8 @@ this example.
 \end{verbatim}
 
 The \pkg{mathtools} package provides a command \cn{shortintertext} that
-is intended for use when the interjected text is only a few words, it uses
-less vertical space than \cn{intertext}; this
+is intended for use when the interjected text is only a few words; it uses
+less vertical space than \cn{intertext}. This
 is most effective when equation numbers are on the right.%
 \index{equationn at equation numbers!left or right placement}
 
@@ -1120,7 +1123,9 @@ commands.%
 }\space%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 (If you need left or right alignment in a column or other special
 formats you may use \env{array}, or the \pkg{mathtools}
- package which provides \verb+*+ variants of these environments with
+package which provides \verb+*+ variants%
+\index{matrix@\indexenvironmentfont{matrix} environment!\verb+*+ variants}
+of these environments with
 an optional argument to specify left or right alignment.)
 
 To produce a small matrix suitable for use in text, there is a
@@ -1133,7 +1138,12 @@ To produce a small matrix suitable for use in text, there is a
 that comes closer to fitting within a single text line than a normal
 matrix. Delimiters\index{delimiters} must be provided. (The
 \pkg{mathtools} package provides |p|,|b|,|B|,|v|,|V| versions of
-\env{smallmatrix}.) The above example was produced by
+\env{smallmatrix},%
+\index{smallmatrix@\indexenvironmentfont{smallmatrix} environment!variant delimiters}
+as well as |*| variants%
+\index{smallmatrix@\indexenvironmentfont{smallmatrix} environment!\verb+*+ variants}
+as described above.)
+The above example was produced by
 \begin{verbatim}
 \bigl( \begin{smallmatrix}
   a&b\\ c&d
@@ -1286,6 +1296,7 @@ To get a superscripted hat or tilde character, load the \pkg{amsxtra}
 package and use \cn{sphat} or \cn{sptilde}. Usage is \verb'A\sphat'
 (note the absence of the \verb'^' character).
 
+
 To place an arbitrary symbol in math accent position, or to get under
 accents, see the \pkg{accents} package by Javier Bezos. (\nipkg{amsmath}
 must be loaded before \pkg{accents}.)
@@ -1598,6 +1609,8 @@ bar symbols:
 \end{verbatim}
 whereupon the document would contain |\abs{z}| to produce $\lvert
 z\rvert$ and |\norm{v}| to produce $\lVert v\rVert$.
+The \pkg{mathools} provides the command \cn{DeclarePairedDelimiter}
+for defining |\abs|-like macros with scaling delimiters.
 \index{delimiters|)}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -1880,11 +1893,13 @@ f(w,x,y,z)\,dw\,dx\,dy\,dz\qquad\idotsint\limits_A f(x_1,\dots,x_k)
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \chapter{Commutative diagrams}\label{s:commdiag}
+\index{commutative diagrams}
 
 Some commutative diagram commands like the ones in \amstex/ are
 available as a separate package, \pkg{amscd}. For complex commutative
 diagrams authors will need to turn to more comprehensive packages like
-\tikz/\index{TikZ@\tikz/ package} or \xypic/\index{XY-pic@\xypic/ package},
+\tikz/\index{TikZ@\tikz/ package} (in particular, \pkg{tikz-cd})
+or \xypic/\index{XY-pic@\xypic/ package},
 but for simple diagrams without diagonal
 arrows\index{arrows!in commutative diagrams} the \pkg{amscd} commands
 may be more convenient. Here is one example.
@@ -2076,6 +2091,8 @@ the printed document has something wrong but there was no \latex/
 error during typesetting.
 
 %% ------------------------------------------------------------------ %%
+%% **********
+\enlargethispage{-2\baselineskip}
 
 \section{Error messages}
 
@@ -2144,6 +2161,9 @@ accidentally left out a newline command \cn{\\} and the above error is
 issued.
 \end{error}
 
+%% **********
+\enlargethispage{1.5\baselineskip}
+
 \begin{error}{Font OMX/cmex/m/n/7=cmex7 not loadable ...}
 \errexa
 \begin{verbatim}
@@ -2643,8 +2663,9 @@ resource for historical investigation.
 Information about obtaining AMSFonts or other \tex/-related
 software from the AMS web server at \fn{www.ams.org}
 can be obtained by sending an email request to
-\mail{tech-support at ams.org}.  This software is also posted on CTAN
-and included in distributions based on \TeX\,Live.
+\mail{tech-support at ams.org}.  This software is also posted on
+CTAN\index{CTAN (Comprehensive \TeX\ Archive Network)} and included
+in distributions based on \TeX\,Live\index{TEX Live@\TeX\,Live}.
 
 The \tex/ Users Group\index{TeX Users@\tex/ Users Group} is a nonprofit
 organization that publishes a journal