[TypeDeclaration] Skip noisy array-shape union return docblock in ReturnTypeFromStrictNewArrayRector - #8422
Merged
Conversation
…urnTypeFromStrictNewArrayRector When multiple returns produce a union of distinct array shapes, the added @return docblock becomes an unreadable union of array shapes. Add the native : array type only and skip the docblock in that case. Claude-Session: https://claude.ai/code/session_019V3LiG3bWd4EyrzsJ5jhAT
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
1 participant
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.
When a method has multiple returns that produce a union of distinct array shapes,
ReturnTypeFromStrictNewArrayRectoradded an unreadable@returndocblock, e.g.:Such a union of array shapes is noise and adds nothing over the native
: arraytype.This adds a complexity guard: when the resolved type contains (at any nesting) a union of 2+ distinct non-empty array variants, only the native
: arraytype is added and the docblock is skipped. Simple cases (list<int>,mixed[],non-empty-array<array{c: mixed}>[]) are unaffected, and themixed[]fallback (empty[]collapsing into a sibling variant) is preserved.