From 6f61a5ee5b3416bcea63b85b18260949890bba9c Mon Sep 17 00:00:00 2001 From: Peter Elmers Date: Sat, 8 Jul 2023 16:50:36 +0200 Subject: [PATCH] Fix small mistakes in function doc comments (#807) --- internal/app/plan.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/internal/app/plan.go b/internal/app/plan.go index 323939b5..1c9b4681 100644 --- a/internal/app/plan.go +++ b/internal/app/plan.go @@ -199,7 +199,7 @@ func execOne(cmd Command, targetRelease *Release) error { return nil } -// printPlanCmds prints the actual commands that will be executed as part of a plan. +// printCmds prints the actual commands that will be executed as part of a plan. func (p *plan) printCmds() { log.Info("Printing the commands of the current plan ...") for _, cmd := range p.Commands { @@ -213,7 +213,7 @@ func (p *plan) printCmds() { } } -// printPlan prints the decisions made in a plan. +// print prints the decisions made in a plan. func (p *plan) print() { log.Notice("-------- PLAN starts here --------------") for _, decision := range p.Decisions { @@ -228,7 +228,7 @@ func (p *plan) print() { log.Notice("-------- PLAN ends here --------------") } -// sendPlanToSlack sends the description of plan commands to slack if a webhook is provided. +// sendToSlack sends the description of plan commands to slack if a webhook is provided. func (p *plan) sendToSlack() { if _, err := url.ParseRequestURI(log.SlackWebhook); err == nil { str := "" @@ -250,7 +250,7 @@ func (p *plan) sendToMSTeams() { } } -// sortPlan sorts the slices of commands and decisions based on priorities +// sort sorts the slices of commands and decisions based on priorities // the lower the priority value the earlier a command should be attempted func (p *plan) sort() { log.Verbose("Sorting the commands in the plan based on priorities (order flags) ... ")