Remove version-dated callouts from API descriptions#4384
Conversation
Strip "as of version YYYY-MM" from deprecation notices and caution blocks. These are migration artifacts that add noise — the behavior is now standard and the dates are irrelevant to current developers. Made-with: Cursor
🚨🚨🚨 Docs migration in progress 🚨🚨🚨We are actively migrating UI extension reference docs to MDX in the
During this migration, please be aware of the following:
Doc comments in Examples that previously lived in this repo are being moved to the What should I do?
Thanks for your patience while we complete the migration! 🙏 |
mcvinci
left a comment
There was a problem hiding this comment.
Thanks, @sordaz00! Same suggestions as #4387 (review).
- market: use relative link, clarify ambiguous "It" pronoun - instructions: reference "cart instructions" explicitly, link to Cart Instructions API - storage: "activated targets associated with" per reviewer suggestion Made-with: Cursor
Summary
Strip "as of version YYYY-MM" from deprecation notices and caution blocks in checkout
standard.ts. These are migration artifacts — the behavior is now standard and the dates are irrelevant to current developers.market: Removed redundant Caution block;@deprecatednow explains why instead of wheninstructions: Removed version date from Caution; states the requirement directlyextensionPoint:@deprecatednow says what to use instead of when it was deprecatedCloses: https://github.com/shop/issues-learn/issues/2001
Test plan
Made with Cursor