Admonitions¶

This page shows the admonitions and related callout directives available in this book.

Generic admonition¶

Use admonition when you want a custom title.

Custom Title

This is a generic admonition with a custom title.

attention¶

Use attention for content that needs immediate focus.

Attention

Pay close attention to the next step.

caution¶

Use caution for content that warns the reader to take care.

Caution

Be careful when changing more than one thing at a time.

danger¶

Use danger for serious risks or major problems.

Danger

This action may break your program.

error¶

Use error for mistakes, failures, or incorrect outcomes.

Error

The program could not complete this task.

hint¶

Use hint to give a small clue without revealing everything.

Hint

Check the spelling of the variable name.

important¶

Use important for key information that should not be missed.

Important

Save your work before you run the program.

note¶

Use note for a general supporting detail.

Note

Python is sensitive to spelling and punctuation.

question¶

Use question to highlight a prompt for the reader to think about or answer.

Predict

What do you think this program will do when it runs?

seealso¶

Use seealso to point the reader to related information.

tip¶

Use tip for a practical suggestion that makes the task easier.

Tip

Test small sections of code before adding more.

warning¶

Use warning when the reader should avoid a likely problem.

Warning

Do not change several lines at once unless you know why.

topic¶

Use topic for a titled callout section that groups related content.

Admonition with code block¶

Code Example

Here is a code block inside an admonition.

print("Hello")

Text can go here too.