Skip to content

fix(admin): use field-generic wording for details/error prop docs (2026-01) - #4664

Merged
sordaz00 merged 1 commit into
2026-01from
so/fix-field-wording-2026-01
Sep 2, 2026
Merged

fix(admin): use field-generic wording for details/error prop docs (2026-01)#4664
sordaz00 merged 1 commit into
2026-01from
so/fix-field-wording-2026-01

Conversation

@sordaz00

@sordaz00 sordaz00 commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Backport of #4662 to 2026-01.

What

The shared FieldDetailsProps.details and FieldErrorProps.error JSDoc in src/surfaces/admin/components.d.ts was written for checkbox ("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_extensions docs 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-01 still carries the checkbox wording today.

(app_home is 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 under src/ or docs/.

🤖 Generated with Claude Code

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
sordaz00 force-pushed the so/fix-field-wording-2026-01 branch from 7a9ad95 to a973dbf Compare September 1, 2026 13:27
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

@sordaz00 sordaz00 self-assigned this Sep 2, 2026
@sordaz00
sordaz00 merged commit f3a9099 into 2026-01 Sep 2, 2026
6 checks passed
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.

2 participants