DOC-7127 Fix incorrect token-bucket throughput claim across 9 rate-limiter pages - #4150
Merged
Merged
Conversation
…miter pages capacity=10, refill_rate=1, refill_interval=1.0 was documented as allowing 10 requests per second with bursts up to 10. The bucket starts full, so the burst-of-10 part is right, but the sustained rate is refill_rate / refill_interval = 1 token/sec, not 10 — the neighboring capacity=100 example on every page already used that formula correctly, which is what exposed this as an arithmetic slip rather than a different intended reading. Reported in #4146. Fixed the shared bullet (DOC-6999's literal) on all 9 client pages plus the matching code comment on redis-py, verified by an end-anchored grep count (9 -> 0 old, 0 -> 9 new) so "bursts up to 100" couldn't false-match as a substring of the "up to 10" pattern. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at cdfa638 |
Contributor
Contributor
Author
|
Thanks @dwdougherty ! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
capacity=10, refill_rate=1, refill_interval=1.0was documented as allowing "10 requests per second with bursts up to 10." The bucket starts full so the burst-of-10 is correct, but the sustained rate isrefill_rate / refill_interval= 1 token/sec, not 10 — the neighboringcapacity=100example on every page already applies that formula correctly, which is what exposes this line as an arithmetic slip.Reported in #4146.
Test plan
capacity=100/capacity=60example lines are unchanged🤖 Generated with Claude Code
Note
Low Risk
Documentation-only wording fixes with no runtime or API changes.
Overview
Corrects a documentation error on all nine token-bucket rate limiter guides (redis-py, Go, Node.js, Java/Jedis, Java/Lettuce, PHP, Ruby, Rust, .NET).
The shared example
capacity=10withrefill_rate/refillRateof 1 per 1.0 second was described as 10 requests per second; it now states 1 request per second with bursts up to 10, matching sustained throughputrefill_rate / refill_intervalwhile keeping burst size atcapacity. The redis-py page’s sample comment is updated the same way.No implementation or config defaults change—only prose in Configuration parameters (and one inline comment on redis-py).
Reviewed by Cursor Bugbot for commit cdfa638. Bugbot is set up for automated code reviews on this repo. Configure here.