hashicorp / hashicorp/terraform-plugin-docs

Generate the document inside the `PlanModifiers`

Open
#549 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Go
Stars
263
Forks
84
Avg merge
3d 6h
Merged PRs (30d)
2

Description

### Terraform CLI and terraform-plugin-docs Versions

```
terraform-provider-adoapi on  ezhong/add-timeout via 🐹 v1.25.5 took 2s
💤 tf version
Terraform v1.14.0-dev
on linux_amd64

Your version of Terraform is out of date! The latest version
is 1.14.3. You can update by downloading from https://developer.hashicorp.com/terraform/install

terraform-provider-adoapi on  ezhong/add-timeout via 🐹 v1.25.5
💤 go tool github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs --version
tfplugindocs Version dev
```

### Use Cases or Problem Statement

The PlanModifers of each attribute implements the `Describer` interface, which implements the `func MarkdownDescription(context.Context) string`. E.g. the `RequiresReplace()` returns a modifier whose description is defined to be: `If the value of this attribute changes, Terraform will destroy and recreate the resource.`.

If this tool can honor thoese descriptions, that would be very helpful!

### Proposal

As above

### How much impact is this issue causing?

Low

### Additional Information

_No response_

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

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.