Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit f79f2f9

Browse files
committed
Add additional comments on the use of \deprecated.
1 parent a2b11ec commit f79f2f9

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

Doc/doc/doc.tex

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -778,7 +778,10 @@ \section{Special Markup Constructs \label{special-constructs}}
778778
\begin{macrodesc}{deprecated}{\p{version}\p{what to do}}
779779
Declare whatever is being described as being deprecated starting
780780
with release \var{version}. The text given as \var{what to do}
781-
should recommend something to use instead.
781+
should recommend something to use instead. It should be
782+
complete sentences. The entire deprecation notice will be
783+
presented as a separate paragraph; it should either preceed or
784+
succeed the description of the deprecated feature.
782785
\end{macrodesc}
783786

784787
\begin{macrodesc}{dfn}{\p{term}}

0 commit comments

Comments
 (0)