Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork9.7k
Remove useless docblocks#24724
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Remove useless docblocks#24724
Uh oh!
There was an error while loading.Please reload this page.
Conversation
nicolas-grekas commentedOct 28, 2017
| Q | A |
|---|---|
| Branch? | 2.7 |
| Bug fix? | no |
| New feature? | no |
| BC breaks? | no |
| Deprecations? | no |
| Tests pass? | yes |
| Fixed tickets | - |
| License | MIT |
| Doc PR | - |
68b6ebf to64437a3Compare| class DoctrineChoiceLoaderimplements ChoiceLoaderInterface | ||
| { | ||
| /** | ||
| * @var ChoiceListFactoryInterface |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
phpstorm requires those annotations for autocomplete AFAIK
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Phpstorm doesn't need them when the type is inferable from the constructor.
| * Create the service definition for the metadata driver. | ||
| * | ||
| * @param ContainerBuilder $containerpassed on in case an extending class | ||
| * @param ContainerBuilder $containerPassed on in case an extending class |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
such changes should probably be reverted as#24149 added a cs rule against doing sentences in phpdoc (no uppercase, no ending dot)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I don't understand the reasoning given there.
In fact, having an uppercase letter makes the docblock easier to read as the eyes more obviously can spot when a new column starts.
The code base is also using uppercase everywhere else. This is not by chance, but because it is most natural to others.
In short, this is something I did on purpose.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
And I fully agree, we just did the contrary when merging it.
This PR was merged into the 2.7 branch.Discussion----------Remove useless docblocks| Q | A| ------------- | ---| Branch? | 2.7| Bug fix? | no| New feature? | no| BC breaks? | no| Deprecations? | no| Tests pass? | yes| Fixed tickets | -| License | MIT| Doc PR | -Commits-------2443511 Remove useless docblocks