> ## 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/dimensions/parameters/description",
  "feedback": "Description of the issue"
}
```

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

</AgentInstructions>

# description

> Provides metadata about the dimension, made available in the workbook UI.

## Syntax

```yaml theme={null}
<dimension_name>:
  description: <description_text>
```

## Properties

<ParamField path="dimension_name" type="object[]">
  The name of the dimension.

  <Expandable title="dimension_name properties" defaultOpen="true">
    <ParamField path="description" type="string">
      A text description of the dimension. Use unquoted text.
    </ParamField>
  </Expandable>
</ParamField>

## Examples

```yaml title="Simple description" theme={null}
full_name:
  description: Full name based on first_name, last_name in CRM
```

```yaml title="Calculated field description" theme={null}
margin:
  sql: ${order_items.sale_price} - ${products.cost}
  description: Profit margin calculated as sale price minus product cost
```