-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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 SlevomatCodingStandard.Commenting.AnnotationName
rule
#6015
Conversation
This looks like something PHPCS should do. |
I agree, but I don't know if PHPCS has a specific rule for this or if the |
Can you please open an issue about this on https://github.com/slevomat/coding-standard ? |
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.
Unless we can have this fixed by PHPCS, I'd like to keep everything as inconsistent as it is.
Seems that both variants are intentionally allowed there. See:
|
I believe both are correct and mean the same thing, but I might be wrong. The sniff that detects such comments that are useless should absolutely detect both. The helper should also detect both. |
e598ecc
to
ff66bcb
Compare
|
d0fecc5
to
2f352cd
Compare
composer.json
Outdated
@@ -40,7 +40,7 @@ | |||
"psr/log": "^1|^2|^3" | |||
}, | |||
"require-dev": { | |||
"doctrine/coding-standard": "11.1.0", | |||
"doctrine/coding-standard": "12.0.0", |
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.
BTW, if we are releasing new CS rules from "doctrine/coding-standard" only in major versions, couldn't we use ^12.0
here?
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.
You're right, we probably should… not sure why we are pinning this one.
@inheritDoc
tags with @inheritdoc
@inheritdoc
tags with @inheritDoc
@inheritdoc
tags with @inheritDoc
SlevomatCodingStandard.Commenting.AnnotationName
rule
Summary
Normalize the usage for the
@inheritdoc
tag.ToDo