Skip to content
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.

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

3.x - Widen the @method annotations to cover the actual return type. #956

Merged
merged 1 commit into from
Oct 20, 2023

Conversation

ndm2
Copy link
Contributor

@ndm2 ndm2 commented Oct 19, 2023

These methods return the same value that they receive, which is iterable. A result set is a possible use-case when passing (possibly modified) query results, but it's not the rule.

While this doesn't have too much of an effect as ResultSetInterface is iterable too, having only ResultSetInterface is incorrect, as not all iterables are result sets.

refs #954

These methods return the same value that they receive, which is
`iterable`. A result set is a possible use-case when passing (possibly
modified) query results, but it's not the rule.
@ndm2 ndm2 requested review from dereuromark and LordSimal October 19, 2023 19:47
@othercorey othercorey added this to the 3.x (CakePHP 5) milestone Oct 19, 2023
@markstory markstory merged commit 5f74e55 into 3.x Oct 20, 2023
8 checks passed
@markstory markstory deleted the 3.x-widen-docblock-method-annotations branch October 20, 2023 16:52
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.

3 participants