mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-24 03:35:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

New markup: \note{...} and \warning{...}

Browse source
This commit is contained in:
Fred Drake 2001-10-09 18:01:23 +00:00
parent 8b78b99647
commit 92350b3a1f
4 changed files with 36 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Doc/doc/doc.tex
View file

@ -859,6 +859,14 @@ This \UNIX\ is also followed by a space.
The name of a Usenet newsgroup.
\end{macrodesc}
\begin{macrodesc}{note}{\p{text}}
An especially important bit of information about an API that a
user should be aware of when using whatever bit of API the
note pertains to. This should be the last thing in the
paragraph as the end of the note is not visually marked in
any way.
\end{macrodesc}
\begin{macrodesc}{pep}{\p{number}}
A reference to a Python Enhancement Proposal. This generates
appropriate index entries. The text \samp{PEP \var{number}} is
@ -989,6 +997,15 @@ This \UNIX\ is also followed by a space.
explanation makes sense and may vary as needed.
\end{macrodesc}
\begin{macrodesc}{warning}{\p{text}}
An important bit of information about an API that a user should
be very aware of when using whatever bit of API the warning
pertains to. This should be the last thing in the paragraph as
the end of the warning is not visually marked in any way. This
differs from \macro{note} in that it is recommended over
\macro{note} for information regarding security.
\end{macrodesc}
\subsection{Module-specific Markup \label{module-markup}}