docs(ratelimit): add missing @param documentation - #61736
Conversation
AndyScherzinger
added
3. to review
| * @param string $methodName | ||
| * @param string $annotationName | ||
| * @param class-string<T> $attributeClass | ||
| * @param string $overwriteKey |
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
There was a problem hiding this comment.
@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.
c970f3e to
d009a21
Compare
Signed-off-by: nakatani-yo <yoshihito.nakatani@craftsman-software.com>
d009a21 to
3e7ba29
Compare
|
@AndyScherzinger |
|
Hello there, We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process. Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6 Thank you for contributing to Nextcloud and we hope to hear from you soon! (If you believe you should not receive this message, you can add yourself to the blocklist.) |
3 participants
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: