[5.6] Fix return docblock for response helper #25147
Merged
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.
Running larastan (a static code analyzer) I got this error
on a similar piece of code to this:
After some digging I realized the docblock isn't entirely correct since the helper can only return an instance of
Illuminate\Contracts\Routing\ResponseFactory
when called empty or an instance ofIlluminate\Http\Response
when given some content, hence the fix for the docblock.Since it's a change on a docblock and not actual code it shouldn't break anything.