[5.0] More Specific DocBlocks #8309
Merged
Conversation
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
| @@ -1613,7 +1613,7 @@ public function sum($column) | |||
| * Retrieve the average of the values of a given column. | |||
| * | |||
| * @param string $column | |||
| * @return mixed | |||
| * @return float|int | |||
There was a problem hiding this comment.
Shouldn't this just be float in all cases?
There was a problem hiding this comment.
Didn't think so? Not sure?
There was a problem hiding this comment.
Makes sense for an average? I'd even say you can do "float" for all of them. Even though PHP may or may not turn some of the values into integers, I don't see a reason why we cannot simply treat them as floats.
There was a problem hiding this comment.
The point is that this method, MIGHT return int, though will return float in most cases.
taylorotwell
added a commit
that referenced
this pull request
Apr 7, 2015
[5.0] More Specific DocBlocks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
These functions always return either an integer or a double, so we should use the most specific types possible in our return annotation.
mixedshould always be avoided when something more specific could be used, likefloat|intin this case.