Repository navigation
[2027-01-rc] Shorten the addressLineComponents doc comment - #4767
Draft
rcaplanshopify wants to merge 5 commits into
Draft
rcaplanshopify wants to merge 5 commits into
rcaplanshopify wants to merge 5 commits into
Conversation
Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
Replace the write-semantics paragraph with a link to the Regional address components guide, per docs review feedback. Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Shortens the
MailingAddress.addressLineComponentsdoc comment insrc/surfaces/checkout/api/shared.tsand regenerates the checkout docs data. The write-semantics paragraph is replaced with a link to the Regional address components guide.Stacked on #4763 so the regen uses
@shopify/generate-docs1.3.0; the first three commits are #4763's and drop out once it merges.Why
Docs review feedback: the type description on the Addresses API page was a dense block that duplicated the guide. The reference now gives the one-line definition and points to the guide for the rest.
Verification
yarn docs:checkout 2027-01-rc— the only change ingenerated_docs_data_v2.jsonis this field's description (3 entries).No changeset: doc-comment and generated-output change only.
Checklist
Forward-port of #4766