Skip to content

Fix typos in JSDoc comments for object utilities#7613

Open
AaronStackBarnes wants to merge 1 commit into
Shopify:mainfrom
AaronStackBarnes:docs/fix-jsdoc-typos-object-utils
Open

Fix typos in JSDoc comments for object utilities#7613
AaronStackBarnes wants to merge 1 commit into
Shopify:mainfrom
AaronStackBarnes:docs/fix-jsdoc-typos-object-utils

Conversation

@AaronStackBarnes
Copy link
Copy Markdown
Contributor

Spotted a couple typos in the JSDoc comments in packages/cli-kit/src/public/common/object.ts while reading through the public API:

  • deepMergeObjects return description: "Javascrip tobject with th emerged" -> "JavaScript object with the merged"
  • setPathValue description: "it's create" -> "it's created"

@AaronStackBarnes AaronStackBarnes requested a review from a team as a code owner May 22, 2026 11:54
Copilot AI review requested due to automatic review settings May 22, 2026 11:54
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Fixes typos in JSDoc comments for public object utilities.

Changes:

  • Corrected misspellings in @returns documentation for deepMergeObjects
  • Improved grammar in the setPathValue JSDoc description

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

* @param arrayMergeStrategy - Strategy used to merge the array typed fields. Union strategy is used by default to avoid
* duplicated elements.
* @returns A Javascrip tobject with th emerged objects.
* @returns A JavaScript object with the merged objects.
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