Add additional comments on the use of \deprecated.
This commit is contained in:
parent
a2b11ecb08
commit
f79f2f94d5
|
@ -778,7 +778,10 @@ This \UNIX\ is also followed by a space.
|
||||||
\begin{macrodesc}{deprecated}{\p{version}\p{what to do}}
|
\begin{macrodesc}{deprecated}{\p{version}\p{what to do}}
|
||||||
Declare whatever is being described as being deprecated starting
|
Declare whatever is being described as being deprecated starting
|
||||||
with release \var{version}. The text given as \var{what to do}
|
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}
|
\end{macrodesc}
|
||||||
|
|
||||||
\begin{macrodesc}{dfn}{\p{term}}
|
\begin{macrodesc}{dfn}{\p{term}}
|
||||||
|
|
Loading…
Reference in New Issue