doc comment for BypassRateLimitCheck (context key)

google · Dec 16, 2024 · 9b253b9 · 9b253b9
1 parent edb51b3
commit 9b253b9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/github/github.go b/github/github.go
@@ -801,7 +801,11 @@ func parseTokenExpiration(r *http.Response) Timestamp {
 type requestContext uint8
 
 const (
+	// BypassRateLimitCheck prevents a pre-emptive check for exceeded primary rate limits
+	// Specify this by providing a context with this key, e.g.
+	//   context.WithValue(context.Background(), github.BypassRateLimitCheck, true)
 	BypassRateLimitCheck requestContext = iota
+
 	SleepUntilPrimaryRateLimitResetWhenRateLimited
 )