[DeadCode] Add RemoveReturnTagIncompatibleWithNativeTypeRector#8172
Merged
Conversation
…ove @return docblock contradicting native return type
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
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.
Adds
RemoveReturnTagIncompatibleWithNativeTypeRectorto the DeadCode set.Removes a
@returndocblock whose type contradicts the declared native return type — the tag is dead/wrong and misleads readers and IDEs.final class SomeClass { - /** - * @return SomeObject - */ public function getName(): string { return $this->someObject->getName(); } }Safe by design
Removes only a true contradiction (
nativeType->isSuperTypeOf(docType)->no()). Legitimate narrowing is kept.@returnstring\stdClassarray\stdClassobject\stdClassarrayint[]string\stdClass+ description\stdClassComplements
RemoveUselessReturnTagRector(equal type) andRemoveMixedDocblockOverruledByNativeTypeRector(mixed); neither covers a contradicting class/scalar@return.