Fix and improve overall PHPDocs #54489
Conversation
e6a8601 to
ccd7a67
Compare
|
This should target 7.1 as it's not a bugfix. |
|
I agree but as it doesn't change any behavior in the code. Wouldn't it be easier for future upmerges and conflicts resolving to push this to 5.4? Also, some phpdocs are wrong, so I guess it can be considered as a bug fix? I'm not sure |
This also remove a few useless ones already inferred in the code
| * @param string[] $tokens the set of split tokens (e.g. COMP_WORDS or argv) | ||
| * @param $currentIndex the index of the cursor (e.g. COMP_CWORD) | ||
| * @param int $currentIndex the index of the cursor (e.g. COMP_CWORD) |
There was a problem hiding this comment.
This is intended.
I think we should rather remove all types everywhere if they duplicate the type defined in PHP (which is almost always the case, except for generic types). See #53363 (comment)
But if we do this, we should automate this using Rector or PHP CS Fixer.
There was a problem hiding this comment.
This is an interesting point of view. Are we 100% we want to do this? Rector could definitely do the trick with this
There was a problem hiding this comment.
Alright, I might close this PR in favor of one that removes redundant types as explained by Wouter. Should such PR target 5.4 or 7.1?
| * @param string $message Exception message to throw | ||
| * @param array $alternatives List of similar defined names | ||
| * @param int $code Exception code | ||
| * @param ?\Throwable $previous Previous exception used for the exception chaining |
There was a problem hiding this comment.
for consistency with other similar changes:
| * @param ?\Throwable $previous Previous exception used for the exception chaining | |
| * @param \Throwable|null $previous Previous exception used for the exception chaining |
| @@ -235,8 +235,7 @@ public function format($timestamp) | |||
| /** | |||
| * Not supported. Formats an object. | |||
| * | |||
| * @param mixed $format | |||
| * @param string $locale | |||
| * @param mixed $format | |||
There was a problem hiding this comment.
| * @param mixed $format | |
| * @param mixed $format |
|
Closing in favor of #54523 |
This also remove a few useless ones already inferred in the code and flipped non-canonical
@varoccurrences.