Documenting Python

Previous: 6.5 Inline Markup Up: 6 Special Markup Constructs Next: 6.7 Module-specific Markup

---

6.6 Miscellaneous Text Markup

In addition to the inline markup, some additional ``block'' markup is defined to make it easier to bring attention to various bits of text. The markup described here serves this purpose, and is intended to be used when marking one or more paragraphs or other block constructs (such as \verbatim environments).

\begin{notice} [type]
\end{notice}

Label some paragraphs as being worthy of additional attention from the reader. What sort of attention is warrented can be indicated by specifying the type of the notice. The only values defined for type are note and warning; these are equivalent in intent to the inline markup of the same name. If type is omitted, note is used. Additional values may be defined in the future.

---

Documenting Python

Previous: 6.5 Inline Markup Up: 6 Special Markup Constructs Next: 6.7 Module-specific Markup

---

Release 2.3.4, documentation updated on December 23, 2004.