From: Fred Drake <fdrake@acm.org>
Date: Tue, 21 May 2002 16:27:20 +0000 (+0000)
Subject: Add additional comments on the use of \deprecated.
X-Git-Tag: v2.3c1~5631
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f79f2f94d5f7e13e0d409d5c00f752280fd3d628;p=python

Add additional comments on the use of \deprecated.
---

diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 4bb2a64198..df6576fef5 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}}