docs: fix typos in comments and user-facing messages - #60
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
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
Fix 13 typos across 5 files - comments, godoc lines and user-facing CLI messages. No functional changes.
command/service_cmd.go- copy-paste in godoc comments (three functions all documented as "updates a service"):// DeleteServiceAction updates a service in OpsGenie->deletes a service// GetServiceAction updates a service in OpsGenie->gets a service// ListServiceAction updates a service in OpsGenie->lists servicescommand/integration_policy_cmd.go-successfuly->successfully(4 occurrences, in enable/disable messages for both policy and integration). The repo already spells itsuccessfullyeverywhere else.command/heartbeat_cmd.goSedning to Opsgenie...->Sending to Opsgenie...Ping request has received.->Ping request has been received.command/command.goimplementations that uses OpsGenie API clients->that use// isEmpty method check is the given argument is empty or not.->checks if the given argumentLogging to file is disabled, To enable Logging to file Please specify logPath->Logging to file is disabled. To enable logging to file, please specify logPathcommand/log_cmd.gobut proceding rest of the log files->but proceeding with the rest of the log filesNotes
Five of the changes are inside user-facing output strings rather than comments, so they will change CLI stdout/stderr text: the four
successfullymessages, the two heartbeat DEBUG messages, thecommand.goINFO log line and thelog_cmd.goDEBUG line. They are all human-readable prose (not machine-parsed keys), and the repo has no test files, so nothing asserts on them - but flagging it for review in case anything downstream greps this output.Deliberately left alone:
Can not->Cannotphrasing. It appears 14 times across 11 files and is clearly the house convention; "can not" is a valid spelling, and changing only some of them would leave the repo inconsistent.governed by a Apache Software licensein the copyright headers ofcommand/command.goandcfg/lamp_config.go- boilerplate legal header text.gofmtreports every file incommand/,cfg/andlamp.goas unformatted already, including files this PR does not touch. I did not rungofmt -w, to keep the diff to the typo fixes.