-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[CS] Apply phpdoc_annotation_without_dot #24149
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
[CS] Apply phpdoc_annotation_without_dot #24149
Conversation
@@ -4,7 +4,7 @@ | |||
|
|||
/** | |||
* @deprecated but this is a test | |||
* deprecation notice. | |||
* deprecation notice |
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.
corresponding assertion needs to be updated
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.
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.
Thanks
Can we fix them (or avoid lcfirst already updated ones)? |
Thank you @keradus. |
This PR was squashed before being merged into the 2.7 branch (closes #24149). Discussion ---------- [CS] Apply phpdoc_annotation_without_dot | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | n/a | Fixed tickets | n/a | License | MIT | Doc PR | n/a Rule was manually applied here : #19198 In same PR, fixer for this rule was requested, later implementation was approved by Symfony in PHP-CS-Fixer/PHP-CS-Fixer#2020 . Rule is converting single sentence to not a sentence, dropping final dot and lowercasing first word. If there are multiple sentences, it doesn't make any changes. Status quo is that some annotation are in the middle - having first word uppercased, but no final stop. Let us fix grammar by finishing applying the rule. If, for some reason, you don't want to follow that rule that was requested by Symfony, please provide reasoning. If it's to some edge-case bug, simply raise that bug issue. If due to some other reasons, please send a PR to drop it from `@Symfony` ruleset. Info: I did manually reviewed every single change of this PR. Commits ------- 7a97b49 [CS] Apply phpdoc_annotation_without_dot
I've just merged 2.7 up to master. I will now re-execute the fixer on each branch to fix all violations introduced since 2.7. |
this PR does, at least for 2.7 line |
thanks @fabpot 👍 |
This PR was merged into the 3.4 branch. Discussion ---------- [Debug] fix test assertion | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Fixes tests for #23816 after the changes made in #24149. Commits ------- 75a26bb [Debug] fix test assertion
@keradus What I mean is that we now have some annotations with first letter uppercased in the middle of a block, that feels inconsistent. IMHO that should be two different rules, or the rule should be named |
name is misleading indeed, yet full rule description is mentioning that. |
Rule was manually applied here : #19198
In same PR, fixer for this rule was requested, later implementation was approved by Symfony in PHP-CS-Fixer/PHP-CS-Fixer#2020 .
Rule is converting single sentence to not a sentence, dropping final dot and lowercasing first word.
If there are multiple sentences, it doesn't make any changes.
Status quo is that some annotation are in the middle - having first word uppercased, but no final stop.
Let us fix grammar by finishing applying the rule.
If, for some reason, you don't want to follow that rule that was requested by Symfony, please provide reasoning. If it's to some edge-case bug, simply raise that bug issue. If due to some other reasons, please send a PR to drop it from
@Symfony
ruleset.Info: I did manually reviewed every single change of this PR.