From 6f43b2f6f23f4a166cd7fcc90a1f9b1651f9c7c3 Mon Sep 17 00:00:00 2001 From: CodeLingo Bot Date: Fri, 15 Mar 2019 13:01:27 +1300 Subject: [PATCH] Fix function comments based on best practices from Effective Go Signed-off-by: CodeLingo Bot --- account.go | 2 +- errors.go | 4 ++-- friends_followers.go | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/account.go b/account.go index aba335f..e670b60 100644 --- a/account.go +++ b/account.go @@ -14,7 +14,7 @@ func (a TwitterApi) VerifyCredentials() (ok bool, err error) { return err == nil, err } -// Get the user object for the authenticated user. Requests /account/verify_credentials +// GetSelf gets the user object for the authenticated user. Requests /account/verify_credentials func (a TwitterApi) GetSelf(v url.Values) (u User, err error) { response_ch := make(chan response) a.queryQueue <- query{a.baseUrl + "/account/verify_credentials.json", v, &u, _GET, response_ch} diff --git a/errors.go b/errors.go index 9acf82a..8fd2fa0 100644 --- a/errors.go +++ b/errors.go @@ -54,12 +54,12 @@ func newApiError(resp *http.Response) *ApiError { } } -// ApiError supports the error interface +// Error supports the error interface func (aerr ApiError) Error() string { return fmt.Sprintf("Get %s returned status %d, %s", aerr.URL, aerr.StatusCode, aerr.Body) } -// Check to see if an error is a Rate Limiting error. If so, find the next available window in the header. +// RateLimitCheck checks to see if an error is a Rate Limiting error. If so, find the next available window in the header. // Use like so: // // if aerr, ok := err.(*ApiError); ok { diff --git a/friends_followers.go b/friends_followers.go index f5bebd1..ef0b477 100644 --- a/friends_followers.go +++ b/friends_followers.go @@ -258,7 +258,7 @@ func (a TwitterApi) FollowUserId(userId int64, v url.Values) (user User, err err return a.postFriendshipsCreateImpl(v) } -// FollowUserId follows the user with the specified screenname (username). +// FollowUser follows the user with the specified screenname (username). // This implements the /friendships/create endpoint, though the function name // uses the terminology 'follow' as this is most consistent with colloquial Twitter terminology. func (a TwitterApi) FollowUser(screenName string) (user User, err error) {