Repository navigation
docs: fix typos in comments and documentation - #62
Merged
Merged
Conversation
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
approved these changes
Sep 7, 2026
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.
Summary
Fixes 18 spelling and grammar typos in code comments, godoc strings and the README. Comments/documentation only, no functional changes;
go build ./...andgo vet ./...pass.From a typo scan (11 items)
// send to remove endpoint->// send to remote endpointthe packet will first be send->will first be sent(the same godoc paragraph appears aboveNewBufferedSenderandNewBufferedSenderWithSender; both fixed so they stay identical)sending to the supplied addresss.->address.so no do this under read lock->so no need to do this under read lock(matches the existingso no need to do it herephrasing further down the same file)statsd.Grahpite->statsd.Graphiteprefix is the stastd client prefix->the statsd client prefixit is recommented to migrate->recommended(4 occurrences)for sending to the supplied addresss.->address.Additionally noticed while checking those files (7 items)
leave ResInetval as the zero value->ResInterval(the field is spelledResIntervalfive lines below, and instatsd/client_config.go)(previous exmaple)->(previous example)though contenion will impact->contentionmultiple sats in the same []byte->stats// : deliniates the stat name->delineatesstat data folows ':'->followsit assums float rendering->assumesNo identifiers were renamed.
iffinclient_config.gowas left alone (it reads as "if and only if"), andCHANGELOG.mdwas 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.gostill namesstatsd.DataDog,statsd.Graphiteandstatsd.Influx, but the exportedTagFormatvalues instatsd/tags.goareSuffixOctothorpe,InfixSemicolonandInfixComma. Only the spelling was fixed; the stale symbol names were left as they are.