-
Notifications
You must be signed in to change notification settings - Fork 9.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add function descriptions #32453
Add function descriptions #32453
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Co-authored-by: kmoe <[email protected]>
Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch. |
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
This PR adds descriptions for all Terraform functions and is the first step in enabling machine-readable function signatures (more: TF-508: Machine-readable function signatures).
It is planned to export the descriptions via a new
terraform metadata functions --json
command. The first consumer of the JSON output will be the Terraform language server, to provide function signature information inside the editor. After that, the docs website might be another potential consumer, making the description list the single source of truth.Instead of iterating over the functions list and using
WithDescription
for each one, I've another approach, referring to description entries from a function definition. But that approach requires edits in multiple places and matching slice indices when one wants to add a parameter description.Target Release
1.4.x