Merge pull request #117 from CodeLingoBot/rewrite

Fix function comments based on best practices from Effective Go
intercom · Mar 19, 2019 · 1dbafb0 · 1dbafb0
2 parents a7c3571 + 8a8e0fb
commit 1dbafb0
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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",