> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://docs.omni.co/feedback

```json
{
  "path": "/modeling/topics/parameters/description",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

# description

> Free text that describes the topic.

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

```yaml theme={null}
# Single line description
description: <description_text>

# Multi-line description
description: |
  <multiline_description_text>
```

## Properties

<ParamField path="description" type="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.
</ParamField>

## Examples

```yaml title="Single line description" theme={null}
description: All transactions related to orders from the online store.
```

```yaml title="Multi-line description" theme={null}
description: |
  Transactions from: California, Washington, and Oregon
```