Guides and Sample Code

Developer

Markup Formatting Reference

On This Page

Important

Add an Important callout to a playground or to the Quick Help for a symbol using the Important delimiter. Multiple Important callouts in Quick Help appear in the description section in the same order as they do in the markup.

Use the callout to highlight information that can have adverse effects on the tasks a user is trying to accomplish.

Works with:

  • ✓ Playgrounds

  • ✓ Symbol documentation

Syntax

  • * | + | - Important: description
  • optional continuation of description

The description displayed in Quick Help for the important callout is created as described in Parameters Section.

Playground Example

  1. /*:
  2.  - Important:
  3.  "The beginning is the most important part of the work."
  4.  \
  5.  –Plato
  6. */
image: Art/MFR_important_2x.png

Quick Help Example

  1. /**
  2.  An example of using the important field
  3.  - Important:
  4.  "The beginning is the most important part of the work."
  5.  \
  6.  –Plato
  7. */
image: ../Art/MFR_symbol_field_important_2x.png