fix(admin): use field-generic wording for details/error prop docs (2026-01) - #4664
Merged
Conversation
Backport of fe157df (#4662) to 2026-01. The shared `FieldDetailsProps.details` and `FieldErrorProps.error` JSDoc was written for `checkbox` and is inherited by every Admin and App Home form component, where it reads incorrectly. Replace it with field-generic wording and update the generated docs data to match. Fixes shop/issues-learn#2959 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
sordaz00
force-pushed
the
so/fix-field-wording-2026-01
branch
from
September 1, 2026 13:27
7a9ad95 to
a973dbf
Compare
Contributor
|
We detected some changes in |
davejcameron
approved these changes
Sep 1, 2026
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.
Backport of #4662 to
2026-01.What
The shared
FieldDetailsProps.detailsandFieldErrorProps.errorJSDoc insrc/surfaces/admin/components.d.tswas written forcheckbox("displayed below the checkbox", "what checking the box means"). Both interfaces are inherited by every Admin and App Home form component, so the copy renders on non-checkbox reference pages where it reads incorrectly.Reported via shopify.dev CSAT feedback. Tracked in shop/issues-learn#2959.
Why this version
admin_extensionsdocs are published per API version on shopify.dev, so each maintained version needs the fix independently. Verified against the live data in World —db/data/docs/templated_apis/admin_extensions/2026-01still carries the checkbox wording today.(
app_homeis published unversioned, so it is fixed by whichever branch syncs last; it is updated here too for consistency within the branch.)Change
Two JSDoc blocks in
components.d.ts, plus the generated docs data: 2 files, 64 replacements total.Note: this version's generator does not emit the interface source blocks, so only the flattened description strings are present — 31 per generated file rather than 40.
The generated JSON was patched textually rather than by running
yarn docs:admin, because the generator copies these strings verbatim. Every occurrence was matched against a known literal — the patch fails loudly on any unrecognized form — all files re-parse as valid JSON, and no residual checkbox wording remains undersrc/ordocs/.🤖 Generated with Claude Code