[12.x] remove @return docblocks on constructors
#55076
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
PHP constructors don't really return anything, so the docblock is kind of unnecessary. this also brings consistency since we have some that use the tag and some that do not. we have a total of 557 constructors in the framework, so we definitely used it more than we didn't, but my personal opinion is this direction makes more sense. https://docs.phpdoc.org/guide/references/phpdoc/tags/return.html#return laravel#702 https://www.php.net/manual/en/language.oop5.decon.php
mohammadrasoulasghari
added a commit
to mohammadrasoulasghari/laravel-framework
that referenced
this pull request
Mar 22, 2025
- Remove unnecessary @return tags from class constructors - Improve docblock consistency across the framework - Follow PHP documentation standards as constructors don't return values Refs: laravel#55076
|
Nice work |
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.
PHP constructors don't really return anything, so the docblock is kind of unnecessary. this also brings consistency since we have some that use the tag and some that do not.
we have a total of 557 constructors in the framework, so we definitely used it more than we didn't, but my personal opinion is this direction makes more sense.
https://docs.phpdoc.org/guide/references/phpdoc/tags/return.html#return #702
https://www.php.net/manual/en/language.oop5.decon.php