docs(ratelimit): add missing @param documentation#61736
Open
nakatani-yo wants to merge 1 commit into
Open
Conversation
nakatani-yo
requested review from
Altahrim,
ArtificialOwl,
icewind1991 and
salmart-dev
and removed request for
a team
AndyScherzinger
approved these changes
Jul 3, 2026
AndyScherzinger
added
3. to review
susnux
reviewed
Jul 3, 2026
| * @param string $methodName | ||
| * @param string $annotationName | ||
| * @param class-string<T> $attributeClass | ||
| * @param string $overwriteKey |
Contributor
There was a problem hiding this comment.
As long as strict types are used in the method signature you do not need to re-declare them in the doc blocks - as long as there is no further information like a description what this parameter is doing
Signed-off-by: nakatani-yo <yoshihito.nakatani@craftsman-software.com>
AndyScherzinger
force-pushed
the
fix/ratelimit-middleware-phpdoc
branch
from
c970f3e to
d009a21
Compare
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
3 participants
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
This PR adds missing
@paramdocumentation for the$overwriteKeyparameter in thereadLimitFromAnnotationOrAttributemethod ofRateLimitingMiddleware. The parameter was present in the method signature but was not documented in the PHPDoc comment block.Checklist
3. to review, feature component)AI (if applicable)
AI Tool Disclosure: