Skip to content

fix: typos in messages, JSDoc, and inline comments#1280

Open
ZLeventer wants to merge 1 commit into
forcedotcom:mainfrom
ZLeventer:fix/typos-and-comment-errors
Open

fix: typos in messages, JSDoc, and inline comments#1280
ZLeventer wants to merge 1 commit into
forcedotcom:mainfrom
ZLeventer:fix/typos-and-comment-errors

Conversation

@ZLeventer
Copy link
Copy Markdown

Summary

11 typos across messages/envVars.md and source files in src/:

Messages (user-visible)

  • envVars.md: "configration" → "configuration" — appears in sfdxDisableTelemetry and sfDisableTelemetry descriptions
  • envVars.md: "CLIcommands" → "CLI commands" — missing space in sfCodeCoverageRequirement description

JSDoc / comments

  • sfError.ts:69: "compatability" → "compatibility"
  • sfError.ts:79: "he underlying error" → "the underlying error" (missing "t")
  • scratchOrgInfoApi.ts:45: "hun org" → "hub org" in @param hubOrgLoginUrl JSDoc
  • org.ts:678: "usersname" → "username" in inline comment
  • org.ts:1308: "sanbox" → "sandbox" in @param JSDoc
  • authInfo.ts:1055: "URls" → "URLs" in inline comment
  • user.ts:247: "Concatinating" → "Concatenating" in comment
  • myDomainResolver.ts:74: "dns loookup" → "dns lookup" (triple-o) in JSDoc
  • testSetup.ts:872: "setTimout" → "setTimeout" in JSDoc

Test plan

  • yarn build passes
  • Existing tests pass
  • All changes are in string literals and comments only — no logic changes

- envVars.md: "configration" -> "configuration" (x2, sfdxDisableTelemetry + sfDisableTelemetry)
- envVars.md: "CLIcommands" -> "CLI commands" (sfCodeCoverageRequirement)
- sfError.ts: "compatability" -> "compatibility" in backwards-compat comment
- sfError.ts: "he underlying error" -> "the underlying error" in JSDoc
- scratchOrgInfoApi.ts: "hun org" -> "hub org" in JSDoc param
- org.ts: "usersname" -> "username" in inline comment
- org.ts: "sanbox" -> "sandbox" in JSDoc param
- authInfo.ts: "URls" -> "URLs" in inline comment
- user.ts: "Concatinating" -> "Concatenating" in comment
- myDomainResolver.ts: "dns loookup" -> "dns lookup" in JSDoc
- testSetup.ts: "setTimout" -> "setTimeout" in JSDoc
@ZLeventer ZLeventer requested a review from a team as a code owner April 24, 2026 15:35
Copy link
Copy Markdown
Contributor

@jshackell-sfdc jshackell-sfdc left a comment

Choose a reason for hiding this comment

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

approve markdown changes only

@ZLeventer
Copy link
Copy Markdown
Author

Thanks for the review! Looks like the CI checks haven't run yet — could someone trigger them when you get a chance?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants