Skip to content

Conversation

@jkodroff
Copy link
Member

Fixes #16320
Fixes #16393
Fixes #15952
Fixes #11953

Clarifies the purpose and proper usage of apply and all methods, adds important warnings about resource creation in callbacks to prevent preview inconsistencies, and fixes syntax errors in code examples to ensure accuracy.

🤖 Generated with Claude Code

Clarifies the purpose and proper usage of apply and all methods, adds important warnings about resource creation in callbacks to prevent preview inconsistencies, and fixes syntax errors in code examples to ensure accuracy.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Copy link
Contributor

claude bot commented Oct 27, 2025

Documentation Review

This is an excellent rewrite that significantly improves the clarity and usability of the apply and all documentation. The changes address multiple issues and make these concepts much more accessible. Great work!

Issues to Address

content/docs/iac/concepts/inputs-outputs/all.md

Line 83 - Capitalization: Proper noun should be capitalized

In Python, you can pass in unnamed arguments to `Output.all` to create an Output list, for example:

content/docs/iac/concepts/inputs-outputs/apply.md

Line 45 - Punctuation: Use an em dash or restructure for better readability

Suppose you want to print the ID of a resource you've created. These kinds of values are outputs—values that cannot be known until after a resource is provisioned. You might try logging the value like you would any other string:

Observations

  1. Code comments: The lifting examples include extensive inline comments (lines 512-514, 527-529, 542-544, 563-569, 585-591). While educational, consider whether some of this explanation might work better as prose text before the code examples rather than as comments within the code.

  2. Python warning clarity (line 550): The phrase "will not work as expected" could be more specific about the actual behavior users will encounter.

  3. Removed JSON section from all.md: The "Creating a JSON object" section was removed. This appears intentional based on the PR description, but verify this content isn't needed elsewhere or if users should be directed to where this information now lives.

Strengths

  • The warning callouts about resource creation in callbacks are extremely valuable and address real user pain points
  • The restructured apply.md is much more focused and accessible
  • Syntax errors in code examples are fixed (Java, Go)
  • The progression from basic → nested → lifting is logical and easy to follow
  • The lifting explanation with notes about edge cases is helpful

Minor Wins

  • Fixed the notes shortcode syntax in the VSCode snippet file

Mention @claude if you'd like me to review any revisions or help with additional changes!

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

Copy link
Contributor

@CamSoper CamSoper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greatly improved, far better than the original. Thank you!

@jkodroff jkodroff enabled auto-merge (squash) October 28, 2025 16:37
@pulumi-bot
Copy link
Collaborator

@jkodroff jkodroff merged commit fb4786c into master Oct 28, 2025
8 checks passed
@jkodroff jkodroff deleted the jkodroff/clarify-apply-and-all branch October 28, 2025 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

4 participants