diff options
Diffstat (limited to 'Doc/doc/doc.tex')
| -rw-r--r-- | Doc/doc/doc.tex | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex index 85eb3f3..00a465f 100644 --- a/Doc/doc/doc.tex +++ b/Doc/doc/doc.tex @@ -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}} |