Enhance @deprecated usage #458
Conversation
| @@ -48,7 +48,7 @@ class BinaryFile | |||
| * | |||
| * Example: text/xml | |||
| * | |||
| * @deprecated Since 5.3.3, use IO\Handler::getMimeType() | |||
| * @deprecated Since 5.3.3, use {@see \Ibexa\Core\IO\IOServiceInterface::getMimeType()} or {@see \Ibexa\Core\IO\IOMetadataHandler::getMimeType()} | |||
There was a problem hiding this comment.
It's outside Contracts namespace so it won't generate a working link. But, it's still better than a reference to a gone class.
There was a problem hiding this comment.
While fixing it, shouldn't we fix this also to follow other deprecation standards? (see PHP Conventions: deprecation standards on our internal wiki - not publicly linking it here on purpose).
| * @deprecated Since 5.3.3, use {@see \Ibexa\Core\IO\IOServiceInterface::getMimeType()} or {@see \Ibexa\Core\IO\IOMetadataHandler::getMimeType()} | |
| * @deprecated 5.3.3 Use {@see \Ibexa\Core\IO\IOServiceInterface::getMimeType()} or {@see \Ibexa\Core\IO\IOMetadataHandler::getMimeType()} |
There was a problem hiding this comment.
I wouldn't insist in this round on fixing the version indication. As you know, with the reboot of version numbers between eZ Publish and eZ Platform, it's a mess. Reading that it's deprecated since 5.3.3, while being on Ibexa DXP 4.6.x, already blows some minds. See #226 how hard it was with @since and never finished.
So, I'm agree that it should be fixed somehow, but not in this PR. I would keep this PR about linking to replacements.
| @@ -48,7 +48,7 @@ class BinaryFile | |||
| * | |||
| * Example: text/xml | |||
| * | |||
| * @deprecated Since 5.3.3, use IO\Handler::getMimeType() | |||
| * @deprecated Since 5.3.3, use {@see \Ibexa\Core\IO\IOServiceInterface::getMimeType()} or {@see \Ibexa\Core\IO\IOMetadataHandler::getMimeType()} | |||
There was a problem hiding this comment.
While fixing it, shouldn't we fix this also to follow other deprecation standards? (see PHP Conventions: deprecation standards on our internal wiki - not publicly linking it here on purpose).
| * @deprecated Since 5.3.3, use {@see \Ibexa\Core\IO\IOServiceInterface::getMimeType()} or {@see \Ibexa\Core\IO\IOMetadataHandler::getMimeType()} | |
| * @deprecated 5.3.3 Use {@see \Ibexa\Core\IO\IOServiceInterface::getMimeType()} or {@see \Ibexa\Core\IO\IOMetadataHandler::getMimeType()} |
adriendupuis
force-pushed
the
enh-deprecation-phpdoc
branch
from
e5e2160 to
84375fd
Compare
Best candidate to replace the gone IO\Handler::getMimeType()
…pe() IOService is more used than IOMetadataHandler, cite both has one could need to be on a different layer
adriendupuis
force-pushed
the
enh-deprecation-phpdoc
branch
from
84375fd to
c420b60
Compare
|
Related PRs:
ibexa/admin-ui#1398
ibexa/product-catalog#1205
ibexa/segmentation#109
ibexa/storefront#175
Description:
In
@deprecatedtags, add links to alternative elements to help navigate in PHP API Ref for future migration to 5.0.Enhanceable entries were quickly found thanks to the hidden report https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/reports/deprecated.html
Previews:
For QA:
Documentation: