Fix function comments based on best practices from Effective Go

Signed-off-by: CodeLingo Bot <[email protected]>

bounces.go

@@ -62,7 +62,7 @@ func (ci *BouncesIterator) Err() error {
 	return ci.err
 }
 
-// Retrieves the next page of items from the api. Returns false when there
+// Next retrieves the next page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error
 func (ci *BouncesIterator) Next(ctx context.Context, items *[]Bounce) bool {
@@ -82,7 +82,7 @@ func (ci *BouncesIterator) Next(ctx context.Context, items *[]Bounce) bool {
 	return true
 }
 
-// Retrieves the first page of items from the api. Returns false if there
+// First retrieves the first page of items from the api. Returns false if there
 // was an error. It also sets the iterator object to the first page.
 // Use `.Err()` to retrieve the error.
 func (ci *BouncesIterator) First(ctx context.Context, items *[]Bounce) bool {
@@ -99,7 +99,7 @@ func (ci *BouncesIterator) First(ctx context.Context, items *[]Bounce) bool {
 	return true
 }
 
-// Retrieves the last page of items from the api.
+// Last retrieves the last page of items from the api.
 // Calling Last() is invalid unless you first call First() or Next()
 // Returns false if there was an error. It also sets the iterator object
 // to the last page. Use `.Err()` to retrieve the error.
@@ -117,7 +117,7 @@ func (ci *BouncesIterator) Last(ctx context.Context, items *[]Bounce) bool {
 	return true
 }
 
-// Retrieves the previous page of items from the api. Returns false when there
+// Previous retrieves the previous page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error if any
 func (ci *BouncesIterator) Previous(ctx context.Context, items *[]Bounce) bool {

credentials.go

@@ -55,12 +55,12 @@ func (ri *CredentialsIterator) Err() error {
 	return ri.err
 }
 
-// Returns the current offset of the iterator
+// Offset returns the current offset of the iterator
 func (ri *CredentialsIterator) Offset() int {
 	return ri.offset
 }
 
-// Retrieves the next page of items from the api. Returns false when there
+// Next retrieves the next page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error
 func (ri *CredentialsIterator) Next(ctx context.Context, items *[]Credential) bool {
@@ -83,7 +83,7 @@ func (ri *CredentialsIterator) Next(ctx context.Context, items *[]Credential) bo
 	return true
 }
 
-// Retrieves the first page of items from the api. Returns false if there
+// First retrieves the first page of items from the api. Returns false if there
 // was an error. It also sets the iterator object to the first page.
 // Use `.Err()` to retrieve the error.
 func (ri *CredentialsIterator) First(ctx context.Context, items *[]Credential) bool {
@@ -101,7 +101,7 @@ func (ri *CredentialsIterator) First(ctx context.Context, items *[]Credential) b
 	return true
 }
 
-// Retrieves the last page of items from the api.
+// Last retrieves the last page of items from the api.
 // Calling Last() is invalid unless you first call First() or Next()
 // Returns false if there was an error. It also sets the iterator object
 // to the last page. Use `.Err()` to retrieve the error.
@@ -129,7 +129,7 @@ func (ri *CredentialsIterator) Last(ctx context.Context, items *[]Credential) bo
 	return true
 }
 
-// Retrieves the previous page of items from the api. Returns false when there
+// Previous retrieves the previous page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error if any
 func (ri *CredentialsIterator) Previous(ctx context.Context, items *[]Credential) bool {

domains.go

@@ -112,12 +112,12 @@ func (ri *DomainsIterator) Err() error {
 	return ri.err
 }
 
-// Returns the current offset of the iterator
+// Offset returns the current offset of the iterator
 func (ri *DomainsIterator) Offset() int {
 	return ri.offset
 }
 
-// Retrieves the next page of items from the api. Returns false when there
+// Next retrieves the next page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error
 func (ri *DomainsIterator) Next(ctx context.Context, items *[]Domain) bool {
@@ -140,7 +140,7 @@ func (ri *DomainsIterator) Next(ctx context.Context, items *[]Domain) bool {
 	return true
 }
 
-// Retrieves the first page of items from the api. Returns false if there
+// First retrieves the first page of items from the api. Returns false if there
 // was an error. It also sets the iterator object to the first page.
 // Use `.Err()` to retrieve the error.
 func (ri *DomainsIterator) First(ctx context.Context, items *[]Domain) bool {
@@ -158,7 +158,7 @@ func (ri *DomainsIterator) First(ctx context.Context, items *[]Domain) bool {
 	return true
 }
 
-// Retrieves the last page of items from the api.
+// Last retrieves the last page of items from the api.
 // Calling Last() is invalid unless you first call First() or Next()
 // Returns false if there was an error. It also sets the iterator object
 // to the last page. Use `.Err()` to retrieve the error.
@@ -186,7 +186,7 @@ func (ri *DomainsIterator) Last(ctx context.Context, items *[]Domain) bool {
 	return true
 }
 
-// Retrieves the previous page of items from the api. Returns false when there
+// Previous retrieves the previous page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error if any
 func (ri *DomainsIterator) Previous(ctx context.Context, items *[]Domain) bool {
@@ -231,7 +231,7 @@ func (ri *DomainsIterator) fetch(ctx context.Context, skip, limit int) error {
 	return getResponseFromJSON(ctx, r, &ri.domainsListResponse)
 }
 
-// Retrieve detailed information about the named domain.
+// GetDomain retrieves detailed information about the named domain.
 func (mg *MailgunImpl) GetDomain(ctx context.Context, domain string) (DomainResponse, error) {
 	r := newHTTPRequest(generatePublicApiUrl(mg, domainsEndpoint) + "/" + domain)
 	r.setClient(mg.Client())
@@ -298,7 +298,7 @@ func (mg *MailgunImpl) CreateDomain(ctx context.Context, name string, password s
 	return resp, err
 }
 
-// Returns delivery connection settings for the defined domain
+// GetDomainConnection returns delivery connection settings for the defined domain
 func (mg *MailgunImpl) GetDomainConnection(ctx context.Context, domain string) (DomainConnection, error) {
 	r := newHTTPRequest(generatePublicApiUrl(mg, domainsEndpoint) + "/" + domain + "/connection")
 	r.setClient(mg.Client())
@@ -330,7 +330,7 @@ func (mg *MailgunImpl) DeleteDomain(ctx context.Context, name string) error {
 	return err
 }
 
-// Returns tracking settings for a domain
+// GetDomainTracking returns tracking settings for a domain
 func (mg *MailgunImpl) GetDomainTracking(ctx context.Context, domain string) (DomainTracking, error) {
 	r := newHTTPRequest(generatePublicApiUrl(mg, domainsEndpoint) + "/" + domain + "/tracking")
 	r.setClient(mg.Client())

email_validation.go

@@ -81,7 +81,7 @@ func NewEmailValidator(apiKey string) *EmailValidatorImpl {
 	}
 }
 
-// Return a new EmailValidator using environment variables
+// NewEmailValidatorFromEnv returns a new EmailValidator using environment variables
 // If MG_PUBLIC_API_KEY is set, assume using the free validation subject to daily usage limits
 // If only MG_API_KEY is set, assume using the /private validation routes with no daily usage limits
 func NewEmailValidatorFromEnv() (*EmailValidatorImpl, error) {
@@ -121,7 +121,7 @@ func (m *EmailValidatorImpl) Client() *http.Client {
 	return m.client
 }
 
-// Returns the API key used for validations
+// APIKey returns the API key used for validations
 func (m *EmailValidatorImpl) APIKey() string {
 	return m.apiKey
 }

events.go

@@ -75,7 +75,7 @@ func (ei *EventIterator) Err() error {
 	return ei.err
 }
 
-// Retrieves the next page of events from the api. Returns false when there
+// Next retrieves the next page of events from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error
 func (ei *EventIterator) Next(ctx context.Context, events *[]Event) bool {
@@ -93,7 +93,7 @@ func (ei *EventIterator) Next(ctx context.Context, events *[]Event) bool {
 	return true
 }
 
-// Retrieves the first page of events from the api. Returns false if there
+// First retrieves the first page of events from the api. Returns false if there
 // was an error. It also sets the iterator object to the first page.
 // Use `.Err()` to retrieve the error.
 func (ei *EventIterator) First(ctx context.Context, events *[]Event) bool {
@@ -108,7 +108,7 @@ func (ei *EventIterator) First(ctx context.Context, events *[]Event) bool {
 	return true
 }
 
-// Retrieves the last page of events from the api.
+// Last retrieves the last page of events from the api.
 // Calling Last() is invalid unless you first call First() or Next()
 // Returns false if there was an error. It also sets the iterator object
 // to the last page. Use `.Err()` to retrieve the error.
@@ -124,7 +124,7 @@ func (ei *EventIterator) Last(ctx context.Context, events *[]Event) bool {
 	return true
 }
 
-// Retrieves the previous page of events from the api. Returns false when there
+// Previous retrieves the previous page of events from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error if any
 func (ei *EventIterator) Previous(ctx context.Context, events *[]Event) bool {

exports.go

@@ -50,7 +50,7 @@ func (mg *MailgunImpl) ListExports(ctx context.Context, url string) ([]Export, e
 	return result, nil
 }
 
-// Get an export by id
+// GetExport gets an export by id
 func (mg *MailgunImpl) GetExport(ctx context.Context, id string) (Export, error) {
 	r := newHTTPRequest(generatePublicApiUrl(mg, exportsEndpoint) + "/" + id)
 	r.setClient(mg.Client())

ips.go

@@ -18,7 +18,7 @@ type okResp struct {
 	Message string `json:"message"`
 }
 
-// Returns a list of IPs assigned to your account
+// ListIPS returns a list of IPs assigned to your account
 func (mg *MailgunImpl) ListIPS(ctx context.Context, dedicated bool) ([]IPAddress, error) {
 	r := newHTTPRequest(generatePublicApiUrl(mg, ipsEndpoint))
 	r.setClient(mg.Client())
@@ -38,7 +38,7 @@ func (mg *MailgunImpl) ListIPS(ctx context.Context, dedicated bool) ([]IPAddress
 	return result, nil
 }
 
-// Returns information about the specified IP
+// GetIP returns information about the specified IP
 func (mg *MailgunImpl) GetIP(ctx context.Context, ip string) (IPAddress, error) {
 	r := newHTTPRequest(generatePublicApiUrl(mg, ipsEndpoint) + "/" + ip)
 	r.setClient(mg.Client())
@@ -48,7 +48,7 @@ func (mg *MailgunImpl) GetIP(ctx context.Context, ip string) (IPAddress, error)
 	return resp, err
 }
 
-// Returns a list of IPs currently assigned to the specified domain.
+// ListDomainIPS returns a list of IPs currently assigned to the specified domain.
 func (mg *MailgunImpl) ListDomainIPS(ctx context.Context) ([]IPAddress, error) {
 	r := newHTTPRequest(generatePublicApiUrl(mg, domainsEndpoint) + "/" + mg.domain + "/ips")
 	r.setClient(mg.Client())

limits.go

@@ -7,7 +7,7 @@ type TagLimits struct {
 	Count int `json:"count"`
 }
 
-// Returns tracking settings for a domain
+// GetTagLimits returns tracking settings for a domain
 func (mg *MailgunImpl) GetTagLimits(ctx context.Context, domain string) (TagLimits, error) {
 	r := newHTTPRequest(generatePublicApiUrl(mg, domainsEndpoint) + "/" + domain + "/limits/tag")
 	r.setClient(mg.Client())

mailgun.go

@@ -248,7 +248,7 @@ func NewMailgun(domain, apiKey string) *MailgunImpl {
 	}
 }
 
-// Return a new Mailgun client using the environment variables
+// NewMailgunFromEnv returns a new Mailgun client using the environment variables
 // MG_API_KEY, MG_DOMAIN, and MG_URL
 func NewMailgunFromEnv() (*MailgunImpl, error) {
 	apiKey := os.Getenv("MG_API_KEY")

mailing_lists.go

@@ -72,7 +72,7 @@ func (li *ListsIterator) Err() error {
 	return li.err
 }
 
-// Retrieves the next page of items from the api. Returns false when there
+// Next retrieves the next page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error
 func (li *ListsIterator) Next(ctx context.Context, items *[]MailingList) bool {
@@ -92,7 +92,7 @@ func (li *ListsIterator) Next(ctx context.Context, items *[]MailingList) bool {
 	return true
 }
 
-// Retrieves the first page of items from the api. Returns false if there
+// First retrieves the first page of items from the api. Returns false if there
 // was an error. It also sets the iterator object to the first page.
 // Use `.Err()` to retrieve the error.
 func (li *ListsIterator) First(ctx context.Context, items *[]MailingList) bool {
@@ -109,7 +109,7 @@ func (li *ListsIterator) First(ctx context.Context, items *[]MailingList) bool {
 	return true
 }
 
-// Retrieves the last page of items from the api.
+// Last retrieves the last page of items from the api.
 // Calling Last() is invalid unless you first call First() or Next()
 // Returns false if there was an error. It also sets the iterator object
 // to the last page. Use `.Err()` to retrieve the error.
@@ -127,7 +127,7 @@ func (li *ListsIterator) Last(ctx context.Context, items *[]MailingList) bool {
 	return true
 }
 
-// Retrieves the previous page of items from the api. Returns false when there
+// Previous retrieves the previous page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error if any
 func (li *ListsIterator) Previous(ctx context.Context, items *[]MailingList) bool {
@@ -215,7 +215,7 @@ func (mg *MailgunImpl) GetMailingList(ctx context.Context, addr string) (Mailing
 	return resp.MailingList, err
 }
 
-// UpdateList allows you to change various attributes of a list.
+// UpdateMailingList allows you to change various attributes of a list.
 // Address, Name, Description, and AccessLevel are all optional;
 // only those fields which are set in the prototype will change.
 //

members.go

@@ -77,7 +77,7 @@ func (li *MemberListIterator) Err() error {
 	return li.err
 }
 
-// Retrieves the next page of items from the api. Returns false when there
+// Next retrieves the next page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error
 func (li *MemberListIterator) Next(ctx context.Context, items *[]Member) bool {
@@ -95,7 +95,7 @@ func (li *MemberListIterator) Next(ctx context.Context, items *[]Member) bool {
 	return true
 }
 
-// Retrieves the first page of items from the api. Returns false if there
+// First retrieves the first page of items from the api. Returns false if there
 // was an error. It also sets the iterator object to the first page.
 // Use `.Err()` to retrieve the error.
 func (li *MemberListIterator) First(ctx context.Context, items *[]Member) bool {
@@ -110,7 +110,7 @@ func (li *MemberListIterator) First(ctx context.Context, items *[]Member) bool {
 	return true
 }
 
-// Retrieves the last page of items from the api.
+// Last retrieves the last page of items from the api.
 // Calling Last() is invalid unless you first call First() or Next()
 // Returns false if there was an error. It also sets the iterator object
 // to the last page. Use `.Err()` to retrieve the error.
@@ -126,7 +126,7 @@ func (li *MemberListIterator) Last(ctx context.Context, items *[]Member) bool {
 	return true
 }
 
-// Retrieves the previous page of items from the api. Returns false when there
+// Previous retrieves the previous page of items from the api. Returns false when there
 // no more pages to retrieve or if there was an error. Use `.Err()` to retrieve
 // the error if any
 func (li *MemberListIterator) Previous(ctx context.Context, items *[]Member) bool {

messages.go

@@ -444,7 +444,7 @@ func (m *Message) AddDomain(domain string) {
 	m.domain = domain
 }
 
-// Retrieve the http headers associated with this message
+// GetHeaders retrieves the http headers associated with this message
 func (m *Message) GetHeaders() map[string]string {
 	return m.headers
 }
@@ -747,7 +747,7 @@ func (mg *MailgunImpl) GetStoredMessageRawForURL(ctx context.Context, url string
 	return mg.GetStoredMessageRaw(ctx, url)
 }
 
-// Retrieves the raw MIME body of a received e-mail message attachment.
+// GetStoredAttachment retrieves the raw MIME body of a received e-mail message attachment.
 func (mg *MailgunImpl) GetStoredAttachment(ctx context.Context, url string) ([]byte, error) {
 	r := newHTTPRequest(url)
 	r.setClient(mg.Client())

mock.go

@@ -54,7 +54,7 @@ func (ms *MockServer) Stop() {
 	ms.srv.Close()
 }
 
-// Return the URL used to connect to the mock server
+// URL returns the URL used to connect to the mock server
 func (ms *MockServer) URL() string {
 	return ms.srv.URL + "/v3"
 }