summaryrefslogtreecommitdiffstats
path: root/Doc/doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2000-05-02 17:43:44 (GMT)
committerFred Drake <fdrake@acm.org>2000-05-02 17:43:44 (GMT)
commitc26cc91c0cb420a9b7ec83f5fcd88a6610f86487 (patch)
treedd83a23c80ee29c04e83e87a48cc1c03ff4abbdb /Doc/doc
parent52e7684af1fb70a806c813372884f4183ce38bb5 (diff)
downloadcpython-c26cc91c0cb420a9b7ec83f5fcd88a6610f86487.zip
cpython-c26cc91c0cb420a9b7ec83f5fcd88a6610f86487.tar.gz
cpython-c26cc91c0cb420a9b7ec83f5fcd88a6610f86487.tar.bz2
Added descriptions of \versionadded and \versionchanged.
Diffstat (limited to 'Doc/doc')
-rw-r--r--Doc/doc/doc.tex20
1 files changed, 20 insertions, 0 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 05ea40d..13bc7ed 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -571,6 +571,26 @@ distribution, to create or maintain whole documents or sections.
\macro{release} in the preamble.
\end{macrodesc}
+ \begin{macrodesc}{versionadded}{\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.
+ \end{macrodesc}
+
+ \begin{macrodesc}{versionchanged}{\op{explanation}\p{version}}
+ The version of Python in which the named feature was changed in
+ some way (new parameters, changed side effects, etc.).
+ \var{explanation} should be a \emph{brief} explanation of the
+ change consisting of a non-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 and after
+ \macro{versionadded}. The location should be selected so the
+ explanation makes sense and may vary as needed.
+ \end{macrodesc}
+
\subsection{Module-specific Markup}