docs: clarify usage of SkipThrottle decorator with named throttlers #2372
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
Explicitly documents the requirement to specify throttler names when using @SkipThrottle @Throttle decorator with named configurations.
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.
Clarifies that
@SkipThrottle()and@Throttle()decorators require explicit throttler names when using named throttler configurations.PR Checklist
PR Type
What is the current behavior?
The documentation doesn't clearly explain that
@SkipThrottle()without parameters doesn't work with named throttlers, leading to silent failures where rate limiting isn't actually skipped.What is the new behavior?
Added clear documentation sections explaining:
Does this PR introduce a breaking change?
Documentation-only change that clarifies existing behavior.
Other information
This addresses a common confusion where developers expect
@SkipThrottle()to work universally, but it requires@SkipThrottle({ throttlerName: true })syntax with named throttlers.