Update autocomplete docs to clarify they apply to Checkout block too #61430
+6
−1
Conversation
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
opr
added
Documentation
Contributor
Testing GuidelinesHi @straku @woocommerce/developer-advocacy, Apart from reviewing the code changes, please make sure to review the testing instructions (Guide) and verify that relevant tests (E2E, Unit, Integration, etc.) have been added or updated as needed. Reminder: PR reviewers are required to document testing performed. This includes:
|
github-actions
bot
added
the
plugin: woocommerce
woocommercebot
requested review from
a team and
straku
and removed request for
a team
Contributor
📝 WalkthroughWalkthroughDocumentation updates clarify that the address autocomplete provider will be registered for both shortcode and block-based checkouts. A changelog entry notes that only docs were updated. No code, tests, or functional behavior changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/features/address-autocomplete/address-autocomplete.md (1)
7-7: Clarify the block checkout naming.Suggest rephrasing to “both the classic shortcode checkout and the Checkout block” so readers immediately connect the note with the official block name called out in the PR title.
📜 Review details
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/features/address-autocomplete/address-autocomplete.md(1 hunks)plugins/woocommerce/changelog/update-autocomplete-docs(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: opr
PR: woocommerce/woocommerce#60776
File: docs/features/address-autocomplete/address-autocomplete.md:172-209
Timestamp: 2025-09-04T22:01:17.403Z
Learning: For WooCommerce address autocomplete provider documentation, keep code examples simple and focused on the core concepts rather than including all WordPress security and best practices, as plugin authors can figure out implementation details themselves.
Learnt from: opr
PR: woocommerce/woocommerce#60891
File: plugins/woocommerce/client/blocks/assets/js/base/components/cart-checkout/address-autocomplete/address-autocomplete.tsx:62-79
Timestamp: 2025-09-24T13:44:37.668Z
Learning: In WooCommerce address autocomplete (plugins/woocommerce/client/blocks/assets/js/base/components/cart-checkout/address-autocomplete/address-autocomplete.tsx), providers should have full control over address data returned from their select method, including overwriting existing fields with empty values. Merging with existing cart address data is not the intended behavior when providers return empty or undefined values.
📚 Learning: 2025-09-04T22:01:17.403Z
Learnt from: opr
PR: woocommerce/woocommerce#60776
File: docs/features/address-autocomplete/address-autocomplete.md:172-209
Timestamp: 2025-09-04T22:01:17.403Z
Learning: For WooCommerce address autocomplete provider documentation, keep code examples simple and focused on the core concepts rather than including all WordPress security and best practices, as plugin authors can figure out implementation details themselves.
Applied to files:
docs/features/address-autocomplete/address-autocomplete.md
📚 Learning: 2025-09-24T13:44:37.668Z
Learnt from: opr
PR: woocommerce/woocommerce#60891
File: plugins/woocommerce/client/blocks/assets/js/base/components/cart-checkout/address-autocomplete/address-autocomplete.tsx:62-79
Timestamp: 2025-09-24T13:44:37.668Z
Learning: In WooCommerce address autocomplete (plugins/woocommerce/client/blocks/assets/js/base/components/cart-checkout/address-autocomplete/address-autocomplete.tsx), providers should have full control over address data returned from their select method, including overwriting existing fields with empty values. Merging with existing cart address data is not the intended behavior when providers return empty or undefined values.
Applied to files:
docs/features/address-autocomplete/address-autocomplete.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Remind reviewers to also review the testing instructions and test coverage
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes proposed in this Pull Request:
How to test the changes in this Pull Request:
Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:
Testing that has already taken place:
Changelog entry
Changelog Entry Details
Significance
Type
Message
Changelog Entry Comment
Comment