Skip to content

DOC-7127 Fix incorrect token-bucket throughput claim across 9 rate-limiter pages - #4150

Merged
andy-stark-redis merged 1 commit into
mainfrom
DOC-7127-rate-limiter-throughput-fix
Sep 29, 2026
Merged

andy-stark-redis merged 1 commit into
mainfrom
DOC-7127-rate-limiter-throughput-fix

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • 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 is correct, but the sustained rate is refill_rate / refill_interval = 1 token/sec, not 10 — the neighboring capacity=100 example on every page already applies that formula correctly, which is what exposes this line as an arithmetic slip.
  • Fixes the shared bullet (the DOC-6999 literal) on all 9 rate-limiter client pages (redis-py, java-jedis, java-lettuce, nodejs, go, php, rust, ruby, dotnet), plus the matching code comment on the redis-py page.

Reported in #4146.

Test plan

  • End-anchored grep confirms 0 remaining instances of the wrong line and 9 instances of the corrected line
  • Confirmed the neighboring capacity=100/capacity=60 example lines are unchanged
  • Reviewed full diff — exactly the 10 intended one-line changes, nothing else touched

🤖 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=10 with refill_rate/refillRate of 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 throughput refill_rate / refill_interval while keeping burst size at capacity. 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.

…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>
@github-actions

github-actions Bot commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

DOC-7127

@github-actions

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 5 related items from repository history (5 new this commit):

Memory updated at cdfa638

@andy-stark-redis andy-stark-redis self-assigned this Sep 29, 2026
@andy-stark-redis
andy-stark-redis requested a review from a team September 29, 2026 10:53
@andy-stark-redis andy-stark-redis added the clients Client library docs label Sep 29, 2026

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@andy-stark-redis

Copy link
Copy Markdown
Contributor Author

Thanks @dwdougherty !

@andy-stark-redis
andy-stark-redis merged commit 2f1e71f into main Sep 29, 2026
100 checks passed
@andy-stark-redis
andy-stark-redis deleted the DOC-7127-rate-limiter-throughput-fix branch September 29, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants