Skip to content

Provide better documentation to the practitioners #37

@v0lkc

Description

@v0lkc

Terraform CLI and Framework Versions

v0.3.1

Use Cases or Problem Statement

We'd appreciate if we could set some custom descriptions to inform the practitioners about the timeouts which are set by default.

Proposal

Add some more attributes to the timeouts.Opts struct that can be used to passthrough descriptions:

e.g.

"timeouts": timeouts.Attributes(ctx, timeouts.Opts{
   Create: true,
   CreateDescription: "Default: 30m",
   // CreateMarkdownDescription: "",
}), 

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