Document ErrGuildLeaderboard

tatsuworks · Dec 23, 2019 · b7284f6 · b7284f6
1 parent 6c79dc4
commit b7284f6
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/error.go b/error.go
@@ -11,6 +11,7 @@ var ErrAdjustBounds = xerrors.New("tatsumakigo: the amount to adjust must be bet
 // for an action is invalid.
 var ErrAdjustInvalid = xerrors.New("tatsumakigo: the amount to adjust for add and remove actions must be above 0")
 
+// ErrLeaderboardLimit is returned by the guild leaderboard endpoint if the limit is not valid.
 var ErrLeaderboardLimit = xerrors.New("tatsumakigo: guild leaderboard limit cannot be less than -1")
 
 func errorRequestFailed(err error) error {