Documentation fixes #1
Conversation
| @@ -31,7 +30,7 @@ | |||
| final class Attributes | |||
| { | |||
| /** | |||
| * @var array<Doctrine\Common\Annotations\Annotation\Attribute> | |||
There was a problem hiding this comment.
Please revert this one..
The Annotation Parser use @var to validate data types during the parse process.
Class[] its not supported.
There was a problem hiding this comment.
Sorry about that. I'll revert that straight away.
|
Any update on this PR? I can rebase it on the current |
| * | ||
| * @param array $data Key-value for properties to be defined in this class | ||
| * @param array $data Key-value for properties to be defined in this class. |
There was a problem hiding this comment.
I didn't follow what was done in your other PRs, but it seems odd to use a period after property descriptions that aren't a complete sentence. In the past, I've reserved use of periods for descriptions that happened to be two or more complete sentences.
There was a problem hiding this comment.
I've seen that in this code base and many others in the past, so that just looked like the natural thing to do. I've indeed done that in the other PRs. That being said, I'm open to following any standard, if there's one. But we're struggling to get anywhere close, see my proposal in DDC-585!
There was a problem hiding this comment.
Just an additional note about the dot: in my opinion, it helps identifying where the comment stops for this parameter, when it's split over several lines.
|
Do you have plans on merging this PR? |
|
@BenMorel I'll merge this if you rebase - just poke me when you think I should do it :) |
| @@ -1,5 +1,4 @@ | |||
| <?php | |||
|
|
|||
There was a problem hiding this comment.
these changes should be reverted IMO
There was a problem hiding this comment.
They really do no harm, and the PR is not really changing any code...
There was a problem hiding this comment.
If we were normalizing the CS here, I would prefer adding this empty line when it is missing rather tha removing it when it is there
There was a problem hiding this comment.
I personally don't mind, TBH I don't remember why I chose to remove it at that time. Let's just decide on either and I will follow the convention! I can start compiling some coding standards as I do that, as it's not the first point on which different people disagree.
|
@Ocramius It's good for me! |
|
@BenMorel sorry, was AFK these days :) Merging, thanks! |
|
@Ocramius Thank you! |
Fixed doc block documentation.