(NFC) Correct type hints for bad null default values #22600
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.
Overview
Correct type hints for bad null default values.
I've been trying to get rid of cases where the phpdoc has been defaulted to
null
, despite an actual value being expected in most cases (e.g.@param null $title
, where$title
is not always expected to benull
). These were added in bulk based on the default argument several years ago.Before
Bad types in PHPDoc comments.
After
Fewer bad docs (there are still a few other tricker examples of this which should be tackled seperately).
Comments
I've just been searching for
@param null
and working through the list. In some cases the default value isnull
but I've not includednull
in the PHPDoc because in practice a proper value is always expected. These could be tidied up at a later date (e.g. to change the default value).