Skip to content

docs(ratelimit): add missing @param documentation #61736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AndyScherzinger merged 1 commit into from
Jul 5, 2026
Merged

docs(ratelimit): add missing @param documentation #61736

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/private/AppFramework/Middleware/Security/RateLimitingMiddleware.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ public function beforeController(Controller $controller, string $methodName): vo
* @param string $methodName
* @param string $annotationName
* @param class-string<T> $attributeClass
* @param string $overwriteKey

@susnux susnux Jul 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

@nakatani-yo nakatani-yo Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@susnux
Thanks for pointing that out!
I thought it would be better to keep them just to ensure better autocompletion and type checking in static analysis tools and IDEs.

* @return ?ARateLimit
*/
protected function readLimitFromAnnotationOrAttribute(Controller $controller, string $methodName, string $annotationName, string $attributeClass, string $overwriteKey): ?ARateLimit {
Expand Down