Class properties that have types should not require a DocBlock #406
Conversation
This file contains 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
|
Failing tests do not appear to be related to this change, but a missing Symfony class: |
ihor-sviziev
requested changes
Jul 14, 2022
m2-community-project
bot
moved this from Ready for Review
to Changes Requested
in Pull Request Progress
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: ready for review
labels
Co-authored-by: Ihor Sviziev <ihor-sviziev@users.noreply.github.com>
Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.inc
Outdated
Show resolved
Hide resolved
m2-community-project
bot
moved this from Changes Requested
to Review in Progress
in Pull Request Progress
m2-community-project
bot
added
Progress: review
and removed
Progress: changes requested
labels
Co-authored-by: Ihor Sviziev <ihor-sviziev@users.noreply.github.com>
ihor-sviziev
approved these changes
Jul 14, 2022
m2-community-project
bot
moved this from Review in Progress
to Reviewer Approved
in Pull Request Progress
|
@sivaschenko Would it be possible to merge this please? |
ihor-sviziev
requested changes
Apr 11, 2023
m2-community-project
bot
moved this from Reviewer Approved
to Changes Requested
in Pull Request Progress
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: approved
labels
…s_properties # Conflicts: # Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.inc
@ihor-sviziev conflict has been resolved |
ihor-sviziev
previously approved these changes
Apr 12, 2023
m2-community-project
bot
moved this from Changes Requested
to Reviewer Approved
in Pull Request Progress
m2-community-project
bot
added
Progress: approved
and removed
Progress: changes requested
labels
|
@magento import PR to magento-commerce/magento-coding-standard repository |
|
@sinhaparul the Pull Request is successfully imported. |
|
See also #476 |
ihor-sviziev
approved these changes
Dec 18, 2023
|
@sinhaparul @sidolov could you please merge it? |
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.
Fixes #404
If a class property has a type, then there should not be a requirement for a DocBlock.
A DocBlock can still be added if desired - this change simply removes the warning for a missing comment block when the property has a defined type.
Note - this does not validate that the type is valid, only that it is not specifically invalid in the same way as https://github.com/magento/magento-coding-standard/blob/develop/Magento2/Sniffs/Annotation/MethodArgumentsSniff.php
Additional: This issue was originally raised against the documentation page (AdobeDocs/commerce-php#23), and was suggested to be raised directly here. The documentation would need to be updated to reflect that DocBlocks are only required for properties without a type.