Skip to content

Generate the document inside the PlanModifiersย #549

@magodo

Description

@magodo

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

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions