fix: typos in JSDoc, comments, and test descriptions#3717
Open
andromia3 wants to merge 1 commit intoShopify:mainfrom
Open
fix: typos in JSDoc, comments, and test descriptions#3717andromia3 wants to merge 1 commit intoShopify:mainfrom
andromia3 wants to merge 1 commit intoShopify:mainfrom
Conversation
No functional changes — all edits are to inline comments, JSDoc strings, or test-description strings passed to `describe`/`it`. JSDoc on public API (visible in IDE tooltips and on shopify.dev): - AnalyticsProvider.tsx: `wether` -> `whether` - generate-seo-tags.ts: `color pallet` -> `color palette` Because these two JSDoc blocks are mirrored into the committed docs/generated/generated_docs_data.json file, the matching strings there are updated in lock-step so the generated file stays in sync with its source. Comment cleanup in the CLI skeleton asset: - locale-check.ts: `still are still` had a redundant `still`, and the following line had a duplicated `the the`. Test descriptions (strings only, no identifier changes): - client.test-d.ts: `fallsback` -> `falls back`; `overriden` -> `overridden`. - storefront.test.ts: `fallsback` -> `falls back`. - environment-variables.test.ts: `doest not fail` -> `does not fail`. - AddToCartButton.test.tsx: `explicity` -> `explicitly` (x2). No changeset needed — no user-facing behavioral changes. The two JSDoc strings that do reach shopify.dev are updated via the generated_docs_data.json file in this same commit.
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.
No functional changes. Every edit is to an inline comment, a JSDoc string, or a test-description string passed to `describe`/`it`. No identifiers, no runtime behaviour, no public API shape touched.
JSDoc on public API
These two live on public types and show up in IDE tooltips + shopify.dev:
```diff
```
```diff
```
("pallet" = shipping platform; "palette" = range of colours.)
Because both strings are mirrored into `packages/hydrogen/docs/generated/generated_docs_data.json` (committed alongside source), that file is updated in the same commit so it stays in sync. If anything drifted, `pnpm run build-docs` would regenerate cleanly.
Comments in a CLI skeleton asset
`packages/cli/assets/routes/locale-check.ts`:
```diff
```
Two independent typos on consecutive lines: a duplicated `still` and a duplicated `the`.
Test-description strings
All are just strings in `it(...)` / `describe(...)` — renaming them is risk-free (no identifiers reference them).
No changeset: none of this is user-facing behaviour, and the Changeset Reminder workflow explicitly notes "If you are making simple updates to examples or documentation, you do not need to add a changeset."