Skip to content

Conversation

@michalsn
Copy link
Member

Description
This PR removes the @internal tag from the Throttler::check() method description.

It seems like a mistake and can be removed, as it doesn't provide meaningful information and might be confusing.

Fixes #9813

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication)
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Copy link
Contributor

@neznaika0 neznaika0 left a comment

Choose a reason for hiding this comment

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

* @internal param int $maxRequests
*/
public function check(string $key, int $capacity, int $seconds)

This is initially a mistake. There may have been changes, but they forgot to update the comment.

In addition, there is an interface mismatch. The returned type is bool

@michalsn
Copy link
Member Author

Any changes to the interface have to go to the 4.7 branch.

@michalsn michalsn merged commit f58bc76 into codeigniter4:develop Dec 1, 2025
49 checks passed
@michalsn
Copy link
Member Author

michalsn commented Dec 1, 2025

Thank you for the review!

@michalsn michalsn deleted the docs/throttler-check-internal branch December 1, 2025 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: Throttler check method signed as @internal

4 participants