traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add description of the "explanation" optional parameter added to the 

\versionadded macro.

Note: this should not be merged into the 2.1 maintenance branch.
This commit is contained in:
Fred Drake 2001-04-18 05:19:06 +00:00
parent 4c6f17a537
commit 3151f44d49
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Doc/doc/doc.tex
View File

@ -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}}