Make identifiers less ambiguous
It's much better for godoc.
--- a/account.go Mon Apr 17 12:07:44 2017 +0200
+++ b/account.go Mon Apr 17 12:15:50 2017 +0200
@@ -100,8 +100,8 @@
// GetAccount returns an account entity
// The returned value can be nil if there is an error or if the
// requested ID does not exist.
-func (g *Client) GetAccount(id int) (*Account, error) {
- account, err := g.getSingleAccount("account", id)
+func (g *Client) GetAccount(accountID int) (*Account, error) {
+ account, err := g.getSingleAccount("account", accountID)
if err != nil {
return nil, err
}
@@ -136,24 +136,24 @@
}
// FollowAccount follows an account
-func (g *Client) FollowAccount(id int) error {
- account, err := g.getSingleAccount("follow", id)
+func (g *Client) FollowAccount(accountID int) error {
+ account, err := g.getSingleAccount("follow", accountID)
if err != nil {
return err
}
- if account != nil && account.ID != id {
+ if account != nil && account.ID != accountID {
return ErrEntityNotFound
}
return nil
}
// UnfollowAccount unfollows an account
-func (g *Client) UnfollowAccount(id int) error {
- account, err := g.getSingleAccount("unfollow", id)
+func (g *Client) UnfollowAccount(accountID int) error {
+ account, err := g.getSingleAccount("unfollow", accountID)
if err != nil {
return err
}
- if account != nil && account.ID != id {
+ if account != nil && account.ID != accountID {
return ErrEntityNotFound
}
return nil
@@ -180,48 +180,48 @@
}
// BlockAccount blocks an account
-func (g *Client) BlockAccount(id int) error {
- account, err := g.getSingleAccount("block", id)
+func (g *Client) BlockAccount(accountID int) error {
+ account, err := g.getSingleAccount("block", accountID)
if err != nil {
return err
}
- if account != nil && account.ID != id {
+ if account != nil && account.ID != accountID {
return ErrEntityNotFound
}
return nil
}
// UnblockAccount unblocks an account
-func (g *Client) UnblockAccount(id int) error {
- account, err := g.getSingleAccount("unblock", id)
+func (g *Client) UnblockAccount(accountID int) error {
+ account, err := g.getSingleAccount("unblock", accountID)
if err != nil {
return err
}
- if account != nil && account.ID != id {
+ if account != nil && account.ID != accountID {
return ErrEntityNotFound
}
return nil
}
// MuteAccount mutes an account
-func (g *Client) MuteAccount(id int) error {
- account, err := g.getSingleAccount("mute", id)
+func (g *Client) MuteAccount(accountID int) error {
+ account, err := g.getSingleAccount("mute", accountID)
if err != nil {
return err
}
- if account != nil && account.ID != id {
+ if account != nil && account.ID != accountID {
return ErrEntityNotFound
}
return nil
}
// UnmuteAccount unmutes an account
-func (g *Client) UnmuteAccount(id int) error {
- account, err := g.getSingleAccount("unmute", id)
+func (g *Client) UnmuteAccount(accountID int) error {
+ account, err := g.getSingleAccount("unmute", accountID)
if err != nil {
return err
}
- if account != nil && account.ID != id {
+ if account != nil && account.ID != accountID {
return ErrEntityNotFound
}
return nil
--- a/notifications.go Mon Apr 17 12:07:44 2017 +0200
+++ b/notifications.go Mon Apr 17 12:15:50 2017 +0200
@@ -24,12 +24,12 @@
// GetNotification returns a notification
// The returned notification can be nil if there is an error or if the
// requested notification does not exist.
-func (g *Client) GetNotification(id int) (*Notification, error) {
- if id < 1 {
+func (g *Client) GetNotification(notificationID int) (*Notification, error) {
+ if notificationID < 1 {
return nil, ErrInvalidID
}
- var endPoint = "notifications/" + strconv.Itoa(id)
+ var endPoint = "notifications/" + strconv.Itoa(notificationID)
var notification Notification
if err := g.apiCall(endPoint, rest.Get, nil, ¬ification); err != nil {
return nil, err
--- a/status.go Mon Apr 17 12:07:44 2017 +0200
+++ b/status.go Mon Apr 17 12:15:50 2017 +0200
@@ -117,10 +117,10 @@
// GetStatus returns a status
// The returned status can be nil if there is an error or if the
// requested ID does not exist.
-func (g *Client) GetStatus(id int) (*Status, error) {
+func (g *Client) GetStatus(statusID int) (*Status, error) {
var status Status
- if err := g.queryStatusData(id, "status", &status); err != nil {
+ if err := g.queryStatusData(statusID, "status", &status); err != nil {
return nil, err
}
if status.ID == 0 {
@@ -130,34 +130,34 @@
}
// GetStatusContext returns a status context
-func (g *Client) GetStatusContext(id int) (*Context, error) {
+func (g *Client) GetStatusContext(statusID int) (*Context, error) {
var context Context
- if err := g.queryStatusData(id, "context", &context); err != nil {
+ if err := g.queryStatusData(statusID, "context", &context); err != nil {
return nil, err
}
return &context, nil
}
// GetStatusCard returns a status card
-func (g *Client) GetStatusCard(id int) (*Card, error) {
+func (g *Client) GetStatusCard(statusID int) (*Card, error) {
var card Card
- if err := g.queryStatusData(id, "card", &card); err != nil {
+ if err := g.queryStatusData(statusID, "card", &card); err != nil {
return nil, err
}
return &card, nil
}
// GetStatusRebloggedBy returns a list of the accounts who reblogged a status
-func (g *Client) GetStatusRebloggedBy(id int) ([]Account, error) {
+func (g *Client) GetStatusRebloggedBy(statusID int) ([]Account, error) {
var accounts []Account
- err := g.queryStatusData(id, "reblogged_by", &accounts)
+ err := g.queryStatusData(statusID, "reblogged_by", &accounts)
return accounts, err
}
// GetStatusFavouritedBy returns a list of the accounts who favourited a status
-func (g *Client) GetStatusFavouritedBy(id int) ([]Account, error) {
+func (g *Client) GetStatusFavouritedBy(statusID int) ([]Account, error) {
var accounts []Account
- err := g.queryStatusData(id, "favourited_by", &accounts)
+ err := g.queryStatusData(statusID, "favourited_by", &accounts)
return accounts, err
}
@@ -186,41 +186,41 @@
}
// DeleteStatus deletes a status
-func (g *Client) DeleteStatus(id int) error {
+func (g *Client) DeleteStatus(statusID int) error {
var status Status
- o := updateStatusOptions{ID: id}
+ o := updateStatusOptions{ID: statusID}
err := g.updateStatusData("delete", o, &status)
return err
}
// ReblogStatus reblogs a status
-func (g *Client) ReblogStatus(id int) error {
+func (g *Client) ReblogStatus(statusID int) error {
var status Status
- o := updateStatusOptions{ID: id}
+ o := updateStatusOptions{ID: statusID}
err := g.updateStatusData("reblog", o, &status)
return err
}
// UnreblogStatus unreblogs a status
-func (g *Client) UnreblogStatus(id int) error {
+func (g *Client) UnreblogStatus(statusID int) error {
var status Status
- o := updateStatusOptions{ID: id}
+ o := updateStatusOptions{ID: statusID}
err := g.updateStatusData("unreblog", o, &status)
return err
}
// FavouriteStatus favourites a status
-func (g *Client) FavouriteStatus(id int) error {
+func (g *Client) FavouriteStatus(statusID int) error {
var status Status
- o := updateStatusOptions{ID: id}
+ o := updateStatusOptions{ID: statusID}
err := g.updateStatusData("favourite", o, &status)
return err
}
// UnfavouriteStatus unfavourites a status
-func (g *Client) UnfavouriteStatus(id int) error {
+func (g *Client) UnfavouriteStatus(statusID int) error {
var status Status
- o := updateStatusOptions{ID: id}
+ o := updateStatusOptions{ID: statusID}
err := g.updateStatusData("unfavourite", o, &status)
return err
}