removed dots at the end of @param and @return #19198
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
See failures :) |
43eb67d to
554303e
Compare
|
tests fixed |
|
@fabpot |
fabpot
added a commit
that referenced
this pull request
Jun 29, 2016
This PR was merged into the 2.7 branch. Discussion ---------- removed dots at the end of @param and @return | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a For phpdocs, we only add dots for sentences like description, but not for @param and @return for instance. This PR fixes this issue. This should probably be added to PHP-CS-Fixer as well (/cc @phansys @keradus). Commits ------- 554303e removed dots at the end of @param and @return
keradus
added a commit
to PHP-CS-Fixer/PHP-CS-Fixer
that referenced
this pull request
Jun 29, 2016
This PR was squashed before being merged into the 1.12 branch (closes #2020). Discussion ---------- Added PhpdocAnnotationWithoutDotFixer ref symfony/symfony#19198 Commits ------- 677b8aa Added PhpdocAnnotationWithoutDotFixer
|
@keradus PHP-CS-Fixer is removing them from other annotations like the deprecation one too. I don't think that is desired? |
5 tasks
fabpot
added a commit
that referenced
this pull request
Sep 11, 2017
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
symfony-splitter
pushed a commit
to symfony/dom-crawler
that referenced
this pull request
Sep 11, 2017
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 : symfony/symfony#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 ------- 7a97b49436 [CS] Apply phpdoc_annotation_without_dot
symfony-splitter
pushed a commit
to symfony/doctrine-bridge
that referenced
this pull request
Sep 11, 2017
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 : symfony/symfony#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 ------- 7a97b49436 [CS] Apply phpdoc_annotation_without_dot
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For phpdocs, we only add dots for sentences like description, but not for @param and @return for instance. This PR fixes this issue.
This should probably be added to PHP-CS-Fixer as well (/cc @phansys @keradus).