Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix small mistakes in function doc comments #807

Merged
merged 1 commit into from
Jul 8, 2023
Merged

Fix small mistakes in function doc comments #807

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions internal/app/plan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 := ""
Expand All @@ -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) ... ")
Expand Down