Terraform Docs: Update output block docs for type attribute#2031
Merged
Terraform Docs: Update output block docs for type attribute#2031
output block docs for type attribute#2031Conversation
Contributor
Vercel Previews Deployed
|
Contributor
Broken Link CheckerThis PR contains broken links, but won't be blocked. Use this report to improve content quality: Quick Actions
Need Help?
Internal LinksExternal Links |
radeksimko
approved these changes
Mar 18, 2026
70f8b1c to
6649628
Compare
6649628 to
57a7793
Compare
BrianMMcClain
approved these changes
Apr 1, 2026
Contributor
BrianMMcClain
left a comment
There was a problem hiding this comment.
Just one small tweak, otherwise LGTM!
One thing I was considering is how we fit this into our style guide. For variables, for example, we list the type first, which matches with the variable blocks reference
I think should probably do the same for outputs, what do you think about moving the type argument first in the model, complete configuration, specification, and the list of H3s they all link to?
| } | ||
| ``` | ||
|
|
||
| Defining type constraints helps your module consumers to understand the shape of your output values. Typing all the output values of a module enables better matching between validation and plan/apply. |
Contributor
There was a problem hiding this comment.
Suggested change
| Defining type constraints helps your module consumers to understand the shape of your output values. Typing all the output values of a module enables better matching between validation and plan/apply. | |
| Defining type constraints helps your module consumers to understand what type of data your module produces. Adding a type to all the output values of a module enables better matching between validation, plans, and apply operations. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
This PR updates the documentation for the new
typeattribute foroutputblocksWhy
Terraform 1.15 will ship with the new attribute
Merge Checklist
If items do not apply to your changes, add (N/A) and mark them as complete.
Pull Request
Content
content/terraform-docs-common/redirects.jsoncfor moved, renamed, or deleted pages across all affected versions. Refer to Redirects for examples and guidance.Reviews