Follow recommendation about multiline type#10804
Merged
Merged
Conversation
Contributor
It's a parser. The text is always open to multiple interpretations. When a line ends with If you start a type with |
Member
Author
|
Makes sense! I'll amend my commit message 👍 |
Apparently, there is consensus about multiline types between: - PHPStan - Psalm - Slevomat Coding Standard See slevomat/coding-standard#1586 (comment) Using parenthesis is less ambiguous, it makes it clear to the parser where the type begins and where it ends. The change has a positive impact on the Psalm baseline, showing that psalm-return annotation was not really understood previously.
derrabus
approved these changes
Jun 28, 2023
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.
Apparently, there is consensus about multiline types between:
See slevomat/coding-standard#1586 (comment)
Using parenthesis is supposed to be less ambiguous, although I cannot explain how it is ambiguous before… maybe if we had the pipes at the beginning of lines instead of the end it would be ambiguous because you could not clearly tell if the return is multiline or not?
Anyway, the change has a positive impact on the Psalm baseline, showing that psalm-return annotation was not really understood previously. Thanks @ondrejmirtes for the heads up!