docs: fix typos in comments and documentation - #58
Open
Avicennasis wants to merge 1 commit into
Open
Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
|
Hooray! All contributors have signed the CLA. |
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 30 typos in doc comments across 7 files. No functional changes -- comments only, with the single exception of one error-message string noted below.
The one substantive fix
GetOldestEvent's doc comment read "will fetch the latest event for a issue", a copy-paste ofGetLatestEvent's comment directly above it. The function body requestsissues/%s/events/oldest, so the comment documented the wrong behaviour. Changed to "will fetch the oldest event for an issue".Grammar / spelling (the rest)
a issue->an issuex11;a issues tag->an issue's tag;happend->happeneda auth->an authx2;a optional->an optional;a empty->an emptyfetchs->fetchesx2;a organization->an organizationa event->an event;a issue->an issuex2 (plus thelatest/oldestfix above)quote->quota;There is not way->There is no waytetting->gettinga exception->an exceptionx2;olds->holdsNotes for reviewers
a empty->an emptychange inclient.gois inside the error textfmt.Errorf("Endpoint can not be a empty string"). It is the only change outside a comment. I grepped the repo -- no test asserts on that string.SymboleAddrindatatype/stacktrace.goand itsjson:"symboleAddr,omitempty"tag. It is misspelled, but it is an exported identifier and the tag must keep matching Sentry's own wire field name, so renaming it would be a breaking API change rather than a typo fix.team.go,userfeedback.go,datatype/message.go, and some_test.gofiles). I kept this PR to the files listed above to stay reviewable; happy to extend it if you would prefer a single sweep.gofmt -lreports the same six files before and after this commit (pre-existing drift underdatatype/), and I left them alone.