Rooba
/
cpython
mirror of https://github.com/python/cpython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add additional comments on the use of \deprecated.

This commit is contained in:
Fred Drake 2002-05-21 16:27:20 +00:00
parent a2b11ecb08
commit f79f2f94d5
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Doc/doc/doc.tex
View 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}}