# WithDescription

- Module: [Aspire.Hosting](/reference/api/go/aspire.hosting.md)
- Version: `17.0.0`
- Kind: `method`
- Defined on: [`ParameterResource`](/reference/api/go/aspire.hosting/parameterresource.md)
- Source: [GitHub](https://github.com/microsoft/aspire/tree/bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f)

Sets the description of the parameter resource.

## Definition

```go
func (ParameterResource) WithDescription(
    description string,
    options ...*WithDescriptionOptions,
) ParameterResource
```

## Parameters

- `description` (`string`) -- The parameter description.
- `options` (`...*WithDescriptionOptions`) -- optional settings, see [Options](#options)

## Options

Optional parameters are passed in a trailing `options ...*WithDescriptionOptions` argument.

- `EnableMarkdown` (`*bool`) -- A value indicating whether the description should be rendered as Markdown. `true` allows the description to contain Markdown elements such as links, text decoration and lists.

## Returns

[`ParameterResource`](/reference/api/go/aspire.hosting/parameterresource.md) -- Resource builder for the parameter.

Returns a handle; failures surface later via `Err()`.

## Applies to

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