[HackDay][Messanger]Improve PHP DocBlock for Messanger Stamps #29529
Conversation
|
Thanks for taking the time to prepare and suggest these changes @Gramzivi. But actually we try to avoid adding "useless" phpdoc and you'll find a bunch of PRs in this repository trying to remove any of these unnecessary docblocks (see #25859 for instance). By "useless" here, I mean:
I hope you'll understand and keep trying to contribute :) |
| private $result; | ||
|
|
||
| /** | ||
| * @var string |
There was a problem hiding this comment.
We don't add @var phpdoc on properties in Symfony, especially when the constructor allows IDEs to infer it already.
| @@ -77,11 +94,17 @@ public function getResult() | |||
| return $this->result; | |||
| } | |||
|
|
|||
| /** | |||
| * @return string | |||
There was a problem hiding this comment.
Please remove this phpdoc. We don't add it when it provides no value compared to the signature. Here, it only duplicates the return type.
There was a problem hiding this comment.
actually, this applies to most places changed in that PR.
|
https://symfony.com/doc/current/contributing/code/standards.html#documentation
We should start clarifying this :) and perhaps add a mention in the PR template even. |
|
Closing as explained, thanks for submitting. |
Add PHPDoc missing params for Messanger Stamps