Add description of the "explanation" optional parameter added to the
\versionadded macro.
Note: this should not be merged into the 2.1 maintenance branch.
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 130e606..a86c450 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -840,12 +840,15 @@
\macro{shortversion} macro.
\end{macrodesc}
- \begin{macrodesc}{versionadded}{\p{version}}
+ \begin{macrodesc}{versionadded}{\op{explanation}\p{version}}
The version of Python which added the described feature to the
- library or C API. This is typically added to the end of the
- first paragraph of the description before any availability
- notes. The location should be selected so the explanation makes
- sense and may vary as needed.
+ library or C API. \var{explanation} should be a \emph{brief}
+ explanation of the change consisting of a capitalized sentence
+ fragment; a period will be appended by the formatting process.
+ This is typically added to the end of the first paragraph of the
+ description before any availability notes. The location should
+ be selected so the explanation makes sense and may vary as
+ needed.
\end{macrodesc}
\begin{macrodesc}{versionchanged}{\op{explanation}\p{version}}