Skip to content

docs: fix typos in comments and documentation - #62

Merged
dropwhile merged 1 commit into
cactus:masterfrom
Avicennasis:docs/fix-typos
Sep 7, 2026
Merged

dropwhile merged 1 commit into
cactus:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown
Contributor

Summary

Fixes 18 spelling and grammar typos in code comments, godoc strings and the README. Comments/documentation only, no functional changes; go build ./... and go vet ./... pass.

From a typo scan (11 items)

  • statsd/sender_buffered.go: // send to remove endpoint -> // send to remote endpoint
  • statsd/sender_buffered.go: the packet will first be send -> will first be sent (the same godoc paragraph appears above NewBufferedSender and NewBufferedSenderWithSender; both fixed so they stay identical)
  • statsd/sender_resolving.go: sending to the supplied addresss. -> address.
  • statsd/sender_resolving.go: so no do this under read lock -> so no need to do this under read lock (matches the existing so no need to do it here phrasing further down the same file)
  • statsd/client_config.go: statsd.Grahpite -> statsd.Graphite
  • statsd/client_config.go: prefix is the stastd client prefix -> the statsd client prefix
  • statsd/client_legacy.go: it is recommented to migrate -> recommended (4 occurrences)
  • statsd/sender.go: for sending to the supplied addresss. -> address.

Additionally noticed while checking those files (7 items)

  • README.md: leave ResInetval as the zero value -> ResInterval (the field is spelled ResInterval five lines below, and in statsd/client_config.go)
  • README.md: (previous exmaple) -> (previous example)
  • statsd/statsdtest/recorder.go: though contenion will impact -> contention
  • statsd/statsdtest/recorder.go: multiple sats in the same []byte -> stats
  • statsd/statsdtest/stat.go: // : deliniates the stat name -> delineates
  • statsd/statsdtest/stat.go: stat data folows ':' -> follows
  • statsd/statsdtest/recorder_test.go: it assums float rendering -> assumes

No identifiers were renamed. iff in client_config.go was left alone (it reads as "if and only if"), and CHANGELOG.md was left untouched as a historical record.

One thing worth a maintainer's eye that this PR deliberately does not change: the comment corrected in client_config.go still names statsd.DataDog, statsd.Graphite and statsd.Influx, but the exported TagFormat values in statsd/tags.go are SuffixOctothorpe, InfixSemicolon and InfixComma. Only the spelling was fixed; the stale symbol names were left as they are.

Fixes spelling and grammar typos in code comments, godoc strings and the
README. No functional changes.

Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
@dropwhile
dropwhile merged commit f71aec3 into cactus:master Sep 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants