summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-05-21 16:27:20 (GMT)
committerFred Drake <fdrake@acm.org>2002-05-21 16:27:20 (GMT)
commitf79f2f94d5f7e13e0d409d5c00f752280fd3d628 (patch)
treec8c2698cf72b1751c59ef68abbc8ee57c1acf145 /Doc
parenta2b11ecb08d3a884726eaa4c3a0277bf005d6e19 (diff)
downloadcpython-f79f2f94d5f7e13e0d409d5c00f752280fd3d628.zip
cpython-f79f2f94d5f7e13e0d409d5c00f752280fd3d628.tar.gz
cpython-f79f2f94d5f7e13e0d409d5c00f752280fd3d628.tar.bz2
Add additional comments on the use of \deprecated.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/doc/doc.tex5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 4bb2a64..df6576f 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -778,7 +778,10 @@ This \UNIX\ is also followed by a space.
\begin{macrodesc}{deprecated}{\p{version}\p{what to do}}
Declare whatever is being described as being deprecated starting
with release \var{version}. The text given as \var{what to do}
- should recommend something to use instead.
+ should recommend something to use instead. It should be
+ complete sentences. The entire deprecation notice will be
+ presented as a separate paragraph; it should either preceed or
+ succeed the description of the deprecated feature.
\end{macrodesc}
\begin{macrodesc}{dfn}{\p{term}}