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.

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 function comments based on best practices from Effective Go #132

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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 example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ func Example() {
}
}

// A daemon that listens to a channel and sends all incoming messages.
// Example_daemon: A daemon that listens to a channel and sends all incoming messages.
func Example_daemon() {
ch := make(chan *gomail.Message)

Expand Down Expand Up @@ -71,7 +71,7 @@ func Example_daemon() {
close(ch)
}

// Efficiently send a customized newsletter to a list of recipients.
// Example_newsletter: Efficiently send a customized newsletter to a list of recipients.
func Example_newsletter() {
// The list of recipients.
var list []struct {
Expand Down Expand Up @@ -99,7 +99,7 @@ func Example_newsletter() {
}
}

// Send an email using a local SMTP server.
// Example_noAuth: Send an email using a local SMTP server.
func Example_noAuth() {
m := gomail.NewMessage()
m.SetHeader("From", "[email protected]")
Expand All @@ -113,7 +113,7 @@ func Example_noAuth() {
}
}

// Send an email using an API or postfix.
// Example_noSMTP: Send an email using an API or postfix.
func Example_noSMTP() {
m := gomail.NewMessage()
m.SetHeader("From", "[email protected]")
Expand Down