Skip to content

docs: fix 53 typos in Go doc comments and error messages - #180

Open
Avicennasis wants to merge 1 commit into
harness:mainfrom
Avicennasis:docs/fix-typos
Open

docs: fix 53 typos in Go doc comments and error messages#180
Avicennasis wants to merge 1 commit into
harness:mainfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fix Go doc convention violations, grammar errors, and typos across 5 files:

client/options.go:

  • Fix "set" → "sets" in 9 With* function doc comments (Go convention: third-person singular)
  • Fix "SDKs default" → "SDK's default" (possessive)

types/slice.go:

  • Fix "return" → "returns" in 10 function doc comments
  • Fix "deference" → "dereference" in validateSlice comment

types/string.go:

  • Fix "check" → "checks" in 7 function doc comments
  • Fix "implement" → "implements" in String doc comment
  • Fix "cant cast to a string" → "can't cast to a string" in error message
  • Fix "match" → "matches" in Match doc comment
  • Fix "greater or equal than" → "greater than or equal to" (×2)
  • Fix "exist" → "exists" in In doc comment

types/number.go:

  • Same return/check/exist patterns as above
  • Fix "cant cast to a number" → "can't cast to a number" in error message

types/int.go:

  • Fix "cant cast to a integer" → "can't cast to an integer" in error message
  • Fix "to a int64" → "to an int64" in intOperator doc comment
  • Same doc comment patterns as above

No functional changes — doc comments and error message strings only. No test assertions reference the old error strings.

Fix Go doc convention violations (third-person singular verbs),
grammar errors, and typos across 5 files:

- client/options.go: "set" → "sets" in 9 With* function docs, "SDKs" → "SDK's"
- types/slice.go: "return" → "returns" in 10 docs, "deference" → "dereference"
- types/string.go: "check" → "checks" in 7 docs, "implement" → "implements",
  "cant" → "can't", "exist" → "exists", "greater or equal than" grammar
- types/number.go: same patterns as string.go plus "cant" → "can't"
- types/int.go: "cant cast to a integer" → "can't cast to an integer",
  "to a int64" → "to an int64", plus same doc patterns
@CLAassistant

CLAassistant commented Jun 23, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

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