From 76aee9f8cfd641e9c56480f810086e605a50470c Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Wed, 18 Apr 2001 17:32:45 +0000 Subject: [PATCH] Add description of the "explanation" optional parameter added to the \versionadded macro. I originally thought this should not be merged into the 2.1 maintenance branch, but reconsidered: documentation changes may actually *use* the new version of the markup, so the lack of this markup variant can reasonably be considered a bug. --- Doc/doc/doc.tex | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex index 130e606e681c..a86c45079de8 100644 --- a/Doc/doc/doc.tex +++ b/Doc/doc/doc.tex @@ -840,12 +840,15 @@ This \UNIX\ is also followed by a space. \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}} -- 2.47.3