Fix docblock return type mismatch in DataReader::read() method #20338
Conversation
This file contains 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
The method's docblock incorrectly stated it always returned an array, while in practice it can also return `false`. This change updates the `@return` annotation to correctly specify `array|false`.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #20338 +/- ##
=========================================
Coverage 64.85% 64.85%
Complexity 11437 11437
=========================================
Files 431 431
Lines 37199 37199
=========================================
Hits 24125 24125
Misses 13074 13074 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Thank you! |
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.
This pull request addresses a mismatch between the docblock return type and the actual behavior of the
DataReader::read()method.Previously, the docblock indicated that the method would return an
array, even thoughfalsehad already been noted in the method’s comment.This change is trivial, but it helps static analysis tools correctly identify the method’s possible return values.