# withDescription

- Module: [Aspire.Hosting](/reference/api/typescript/aspire.hosting.md)
- Version: `13.2.0`
- Kind: `method`
- Source: [GitHub](https://github.com/microsoft/aspire)

Sets a parameter description

## Definition

```typescript
interface ParameterResource {
  // ... omitted for brevity
  withDescription(
    description: string,
    enableMarkdown?: boolean): ParameterResource
}
```

## Parameters

- `description` (`string`)
- `enableMarkdown` (`boolean`) `optional` `= False`

## Returns

[ParameterResource](/reference/api/typescript/aspire.hosting/parameterresource.md) `builder`

## Applies to

- [ParameterResource](/reference/api/typescript/aspire.hosting/parameterresource.md)