]> granicus.if.org Git - python/commitdiff
Add additional comments on the use of \deprecated.
authorFred Drake <fdrake@acm.org>
Tue, 21 May 2002 16:27:20 +0000 (16:27 +0000)
committerFred Drake <fdrake@acm.org>
Tue, 21 May 2002 16:27:20 +0000 (16:27 +0000)
Doc/doc/doc.tex

index 4bb2a6419838ba0cf561b44ee8ecf62c481e4990..df6576fef5be2feb199c36a39b36f5397541a36a 100644 (file)
@@ -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}}