-
Notifications
You must be signed in to change notification settings - Fork 160
Single line @inheritdoc shouldn't be allowed? #113
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
Comments
Thanks @lenaorobei. Inheritdoc is currently under process of complete removal in Vinai devdocs PR. |
@celorodovalho please refer this PR for more details magento/devdocs#4425 |
@celorodovalho mentioned PR is merged DevDocs are reflecting Magento recommendation. We also have an issue to implement corresponding rule and replace with the existing one #54 If you feel like DevDocs contain wrong information please do not hesitate to open magento/devdocs issue. |
AC-1509: Remove outdated JSCS static tests from magento
Description
Accord with https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#2-conventions-used-in-this-document, we can use single line annotations for @inheritdoc DocBlocks. But, there is no mention about "single line / inline @inheritdoc" in Magento Guidelines (https://devdocs.magento.com/guides/v2.3/coding-standards/docblock-standard-general.html#inheritdoc), and if run the phpcs from Magento, I got a exception about:
Expected behavior
Allowance to use single line / inline DocBlocks to @inheritdoc
Benefits
Conformity with php-fig default standards
Additional information
If I use:
Like described in documentation () I still get a error:
Why? If I want to inherit the entire doc block from the parent method?
The text was updated successfully, but these errors were encountered: