Skip to main content
Free text that describes the topic. Descriptions are visible in the workbook, specifically in the topic switcher of the Fields & Topics panel. For example, you could add copy that describes the type of analyses users can create using the topic.

​
Syntax

# Single line description
description: <description_text>

# Multi-line description
description: |
  <multiline_description_text>

​
Properties

​
description
string
Free text that describes the topic. For multiline descriptions or descriptions containing special characters like colons, use the pipe (|) syntax. Values should be unquoted.

​
Examples

Single line description
description: All transactions related to orders from the online store.
Multi-line description
description: |
  Transactions from: California, Washington, and Oregon