Document specific errors returned by CheckResponse.

google · Feb 11, 2016 · 76866e1 · 76866e1
1 parent 5a4a230
commit 76866e1
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/github/github.go b/github/github.go
@@ -434,6 +434,9 @@ func (e *Error) Error() string {
 // the 200 range.  API error responses are expected to have either no response
 // body, or a JSON response body that maps to ErrorResponse.  Any other
 // response body will be silently ignored.
+//
+// The error type will be *RateLimitError for rate limit exceeded errors,
+// and *TwoFactorAuthError for two-factor authentication errors.
 func CheckResponse(r *http.Response) error {
 	if c := r.StatusCode; 200 <= c && c <= 299 {
 		return nil