Skip to content

docs: fix typos in comments and user-facing messages - #60

Open
Avicennasis wants to merge 1 commit into
opsgenie:masterfrom
Avicennasis:docs/fix-typos
Open

docs: fix typos in comments and user-facing messages#60
Avicennasis wants to merge 1 commit into
opsgenie:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

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 services

command/integration_policy_cmd.go - successfuly -> successfully (4 occurrences, in enable/disable messages for both policy and integration). The repo already spells it successfully everywhere else.

command/heartbeat_cmd.go

  • Sedning to Opsgenie... -> Sending to Opsgenie...
  • Ping request has received. -> Ping request has been received.

command/command.go

  • package doc: implementations that uses OpsGenie API clients -> that use
  • // isEmpty method check is the given argument is empty or not. -> checks if the given argument
  • log line: Logging to file is disabled, To enable Logging to file Please specify logPath -> Logging to file is disabled. To enable logging to file, please specify logPath

command/log_cmd.go

  • but proceding rest of the log files -> but proceeding with the rest of the log files

Notes

Five of the changes are inside user-facing output strings rather than comments, so they will change CLI stdout/stderr text: the four successfully messages, the two heartbeat DEBUG messages, the command.go INFO log line and the log_cmd.go DEBUG 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:

  • The Can not -> Cannot phrasing. 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 license in the copyright headers of command/command.go and cfg/lamp_config.go - boilerplate legal header text.
  • gofmt reports every file in command/, cfg/ and lamp.go as unformatted already, including files this PR does not touch. I did not run gofmt -w, to keep the diff to the typo fixes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant