Documentation Archive

Developer

Markup Formatting Reference

On This Page

Returns

Add the Returns section to Quick Help for a symbol using the Returns delimiter. Use the delimiter to document the item returned by a symbol.

Works with:

  •     Playgrounds

  • ✓ Symbol documentation

Syntax

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

The description displayed in Quick Help for the returns section is created as described in Parameters Section.

Example

  1. /// - Returns: A random number between `min` and `max`
image: ../Art/MFR_symbol_section_returns_2x.png