Skip to content

Conversation

@iwahbe
Copy link
Member

@iwahbe iwahbe commented Nov 17, 2025

The behavior of import changed with pulumi/pulumi#19339, and our docs should reflect the current behavior.

Proposed changes

Unreleased product version (optional)

Related issues (optional)

@iwahbe iwahbe requested a review from CamSoper November 17, 2025 09:43
@iwahbe iwahbe self-assigned this Nov 17, 2025
@claude
Copy link
Contributor

claude bot commented Nov 17, 2025

Documentation Review

I've reviewed the changes to the import documentation. Overall, this PR accurately reflects the behavior change from pulumi/pulumi#19339. Here are my findings:

✅ Positive Changes

  1. Improved note formatting (lines 46-48): Moving the Python import underscore note from a code comment to a proper notes shortcode improves visibility and follows documentation conventions.

  2. Accurate behavior update (lines 199-217): The new text correctly describes that imports now succeed and update resources to match program inputs, rather than failing on mismatch. The example console output is helpful and realistic.

📝 Issues Found

1. Grammar issue (line 199)

File: content/docs/iac/concepts/resources/options/import.md:199

The phrase "the import will succeed and then the resource will be modified" could be clearer. Consider:

If the resource's arguments differ from the imported state, the import will succeed, and the resource will then be modified to reflect the inputs in your Pulumi program.

Rationale: Adding a comma after "succeed" improves readability in this compound sentence.

2. Terminology consistency (line 220)

File: content/docs/iac/concepts/resources/options/import.md:220

The term "import-update" is introduced without prior explanation and may be confusing. Consider:

Because of auto-naming, it is common to see this update during import when you import a resource's name property.

Rationale: "import-update" is not a standard Pulumi term and may confuse readers. The revised text is clearer and more natural.

3. Code block language tag (line 201)

File: content/docs/iac/concepts/resources/options/import.md:201

The code fence uses console but according to STYLE-GUIDE.md, console output should use output or bash for commands. Since this shows command + output, consider splitting or using bash:

Replace the console code fence with bash for consistency with the style guide.

Rationale: Consistency with style guide for code block language tags.

Summary

The PR successfully updates the documentation to reflect the new import behavior. The three issues above are minor style and clarity improvements. The content is technically accurate and the example is helpful.


Need additional reviews or want me to help fix these issues? Mention @claude in a comment.

@iwahbe
Copy link
Member Author

iwahbe commented Nov 17, 2025

@claude Please implement your suggestions. For (3), let's use bash.

@claude
Copy link
Contributor

claude bot commented Nov 17, 2025

Claude finished @iwahbe's task —— View job


Implementing Review Suggestions

Tasks

  • Read current file state
  • Apply grammar fix (line 199)
  • Apply terminology consistency fix (line 220)
  • Change code block language tag from console to bash (line 201)
  • Commit and push changes

Summary

I've successfully implemented all three review suggestions:

  1. Grammar fix (line 199): Added a comma after "succeed" to improve readability: "the import will succeed, and the resource will then be modified..."

  2. Terminology consistency (line 220): Replaced the unclear "import-update" term with clearer phrasing: "it is common to see this update during import when you import..."

  3. Code block language tag (line 201): Changed the code fence from console to bash for consistency with the style guide.

All changes have been committed and pushed to the PR branch.

--- |

iwahbe and others added 2 commits November 17, 2025 10:57
The behavior of import changed with pulumi/pulumi#19339, and our
docs should reflect the current behavior.
- Improve grammar in line 199 by adding comma after 'succeed'
- Replace 'import-update' terminology with clearer phrasing on line 220
- Change code block language tag from console to bash on line 201

Co-authored-by: Ian Wahbe <[email protected]>
@pulumi-bot
Copy link
Collaborator

@iwahbe iwahbe requested a review from a team November 17, 2025 10:46
@iwahbe iwahbe merged commit 1bb02ff into master Nov 21, 2025
11 checks passed
@iwahbe iwahbe deleted the iwahbe/correct-import branch November 21, 2025 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants