docs: fix typos in comments and error messages - #204
Open
Avicennasis wants to merge 1 commit into
Open
Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
Fixes misspellings, a duplicated word, and several copy-paste errors in comments and error strings across the AWS collector, pricing and Slack notifier packages. No identifiers renamed; no logic changes.
This branch has not been deployed
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 12 verified typos across 7 files - misspellings, a duplicated word, and several copy-paste mistakes in comments and error strings. No identifiers were renamed and no logic changed.
"invalid elbv2 volumes client"->"invalid elbv2 client"(there are no volumes here);// Detect check with ELBV2 instance->// Detect checks which ELBV2 instance;return list of load loadbalancers->return list of loadbalancers"invalid elb volumes client"->"invalid elb client";// Detect check with ELB instance->// Detect checks which ELB instance(also drops the doubled space)"invalid lambda volumes client"->"invalid neptune client"(copy-pasted fromlambda.go; this is the Neptune detector)// Detect check with elasticache instance is under utilization->// Detect checks which NAT gateway is under utilization(copy-pasted fromelasticache.go)is under utilized->is underutilizedrate code form getting->rate code for getting;PricingResponse describ the response->PricingResponse describe the response;PriceCurrencyCode Descrive->PriceCurrencyCode describeif is it email->if it is emailPlease review carefully
Three of these are error strings, not comments, so the text returned by
NewELBV2Manager,NewELBManagerandNewNeptuneManageron a bad client changes. I grepped the test suite (elbv2_test.go,elb_test.go,neptune_test.go) - nothing asserts on these strings - and the wording now matches the correct form already used inec2.go,rds.go,elasticache.goandnatgateway.go("invalid <service> client").The
// Detect checks which ...wording was chosen to match the already-correct comments inkinesis.goandneptune.gorather than inventing new phrasing.Deliberately left alone
ELBV2ClientDescreptor,EC2ClientDescreptor,ELBClientDescreptorandPricingClientDescreptor(and their doc comments). Newer files such asnatgateway.goalready spell it...ClientDescriptor, so these look like real defects, but renaming exported types is an API change and out of scope for a typo PR. Happy to open a separate PR if you want them fixed.// Detect check with ...phrasing inrds.go,docdb.go,elasticache.go,redshift.goandelasticsearch.go(redshift.goalso carries the elasticache copy-paste), and the same spuriousvolumesin the error strings ofkinesis.go,iam.go,redshift.go,lambda.goandelasticsearch.go. Kept out to keep this PR scoped - say the word and I will fold them in.gofmtreports no new formatting issues from this change.