From 8a8e0fba1b8b7c33ecc84edd7613dbc81d10098f Mon Sep 17 00:00:00 2001 From: CodeLingo Bot Date: Fri, 15 Mar 2019 13:21:11 +1300 Subject: [PATCH] Fix function comments based on best practices from Effective Go Signed-off-by: CodeLingo Bot --- admin.go | 2 +- contact.go | 2 +- intercom.go | 2 +- user.go | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/admin.go b/admin.go index 7b3e3ac..26f217e 100644 --- a/admin.go +++ b/admin.go @@ -33,7 +33,7 @@ func (a Admin) IsNobodyAdmin() bool { return a.Type == "nobody_admin" } -// Get the address for a Contact in order to message them +// MessageAddress gets the address for a Contact in order to message them func (a Admin) MessageAddress() MessageAddress { return MessageAddress{ Type: "admin", diff --git a/contact.go b/contact.go index 4689c49..2bff906 100644 --- a/contact.go +++ b/contact.go @@ -107,7 +107,7 @@ func (c *ContactService) Delete(contact *Contact) (Contact, error) { return c.Repository.delete(contact.ID) } -// Get the address for a Contact in order to message them +// MessageAddress gets the address for a Contact in order to message them func (c Contact) MessageAddress() MessageAddress { return MessageAddress{ Type: "contact", diff --git a/intercom.go b/intercom.go index 323da54..7949fa2 100644 --- a/intercom.go +++ b/intercom.go @@ -67,7 +67,7 @@ func NewClient(appID, apiKey string) *Client { return &intercom } -// Returns a new Intercom API client, configured with the supplied HTTPClient interface +// NewClientWithHTTPClient returns a new Intercom API client, configured with the supplied HTTPClient interface func NewClientWithHTTPClient(appID, apiKey string, httpClient interfaces.HTTPClient) *Client { intercom := Client{AppID: appID, APIKey: apiKey, baseURI: defaultBaseURI, debug: false, clientVersion: clientVersion, HTTPClient: httpClient} intercom.setup() diff --git a/user.go b/user.go index 71752d4..7dcf446 100644 --- a/user.go +++ b/user.go @@ -143,7 +143,7 @@ func (u *UserService) Delete(id string) (User, error) { return u.Repository.delete(id) } -// Get the address for an User in order to message them +// MessageAddress gets the address for an User in order to message them func (u User) MessageAddress() MessageAddress { return MessageAddress{ Type: "user",