Fix rate limiter documentation for default burst value#2925
Open
karesansui-u wants to merge 1 commit intolabstack:masterfrom
Open
Fix rate limiter documentation for default burst value#2925karesansui-u wants to merge 1 commit intolabstack:masterfrom
karesansui-u wants to merge 1 commit intolabstack:masterfrom
Conversation
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
1 participant
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.
The documentation for
NewRateLimiterMemoryStoreandNewRateLimiterMemoryStoreWithConfigstates that the default Burstvalue is the "rounded down" value of the rate. This was accurate when
the documentation was added in #2366, where the code used
int(config.Rate).However, #2852 changed the default burst calculation to use
math.Ceil,making it the rounded up value. The documentation was not updated to
reflect this change.