hashicorp / hashicorp/terraform-plugin-docs

feat: add default values to attributes to documentation

Open
#65 4 comments 3 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
263
Forks
84
Avg merge
3d 6h
Merged PRs (30d)
2

Description

## Current behavior

Given the schema entry:

```go
"rm": {
Type: schema.TypeBool,
Description: "If true, then the container will be automatically removed after his execution.",
Default: false,
Optional: true,
},
```

the rendered output is

```md
- **rm** (Boolean) If true, then the container will be automatically removed after his execution.
```

## Desired behavior

I'd like to have `Defaults to abc` in the generation as well as follows:

```md
- **rm** (Boolean) If true, then the container will be automatically removed after his execution. Defaults to `false`
```

## Versions
- terraform-plugin-docs: `v0.4.0`
- terraform-plugin-sdk/v2 `v2.6.1`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.