builtin/provider/terraform: Add field descriptions #26836
Merged
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.
These fields are well documented in the docs, but this provides descriptions for the schema export (
terraform providers schema -json
) which is in turn used by the language server.In other words this enhances the user experience of user editing configuration with the Terraform language server - we can display these descriptions e.g. in completion selectbox or on hover.
I have mostly copy-pasted these from the linked docs and it seems that we use dot at the end of every description. I'm assuming this is intended, even though in most cases it's not a full sentence? Someone with better english grammar knowledge please confirm or correct me if I'm wrong. cc @nfagerlund