8000 Remove useless docblocks by nicolas-grekas · Pull Request #24724 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2017
Merged

Conversation

nicolas-grekas
Copy link
Member
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 -

@nicolas-grekas nicolas-grekas added this to the 2.7 milestone Oct 28, 2017
@nicolas-grekas nicolas-grekas changed the title [ProxyManager] Remove useless docblock Remove useless docblocks Oct 28, 2017
@nicolas-grekas nicolas-grekas force-pushed the cleanups27 branch 3 times, most recently from 68b6ebf to 64437a3 Compare October 28, 2017 21:32
@@ -23,29 +23,10 @@
*/
class DoctrineChoiceLoader implements ChoiceLoaderInterface
{
/**
* @var ChoiceListFactoryInterface
Copy link
Contributor

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

Copy link
Member Author

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.

@@ -178,7 +178,7 @@ protected function getChainDriverServiceName(ContainerBuilder $container)
/**
* Create the service definition for the metadata driver.
*
* @param ContainerBuilder $container passed on in case an extending class
* @param ContainerBuilder $container Passed on in case an extending class
Copy link
Member

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)

Copy link
Member Author

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.

Copy link
Member

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.

@nicolas-grekas nicolas-grekas merged commit 2443511 into symfony:2.7 Nov 5, 2017
nicolas-grekas added a commit that referenced this pull request Nov 5, 2017
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
@nicolas-grekas nicolas-grekas deleted the cleanups27 branch November 5, 2017 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants
0