Note¶
Note
A note is a bit of information that adds to the article by clarifying something.
To see how these directives are built, select the Source icon at the bottom of the page. It shows the plain text used to produce this document.
A note can contain multiple paragraphs.
The note ends where the indentation ends.
There are also tip, caution, warning, important, and seealso directives, each with its own color styling.
Tip
This is a tip with an idea of how to do something that you might not have thought of otherwise.
Caution
This is a caution to be careful how you do something or it may not work.
Warning
This is a warning that you could do some damage if you do this.
Important
This is an important step that is easily overlooked, and the feature will not work without it.
See also
This is a seealso directive with a link Admonition
Latest Update |
10/22/2026 |
Updated how to view the page source and listed every note directive.