? Pending

User tests: Successful: Unsuccessful:

avatar PhilETaylor
PhilETaylor
21 May 2021

Code review

It seems previously someone was optimistic that they could remove CMSObject in Joomla 4.0.0

As this clearly has not happened, and Joomla 4.0.0 very much still depends on CMSObject I have updated the @deprecated tag to the next major series, which will be the next opportunity to remove this class.

b45da11 21 May 2021 avatar PhilETaylor s/4/5
avatar PhilETaylor PhilETaylor - open - 21 May 2021
avatar PhilETaylor PhilETaylor - change - 21 May 2021
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 21 May 2021
Category Libraries
avatar brianteeman
brianteeman - comment - 21 May 2021

deprecated in 4 removed in 5

avatar PhilETaylor
PhilETaylor - comment - 21 May 2021

open to interpretation unfortunately

There are MANY interpretations in Joomla of the use of the @deprecated tag

Eg:

* @deprecated  5.0 Without replacement

* @deprecated 4.0.0

avatar PhilETaylor
PhilETaylor - comment - 21 May 2021

https://pear.php.net/package/PhpDocumentor/docs/latest/phpDocumentor/tutorial_tags.deprecated.pkg.html

Document elements that have been deprecated and should not be used as they may be removed at any time from a future version

So the "future version" given is the version that the code can be removed from. Is my interpretation.

avatar brianteeman
brianteeman - comment - 21 May 2021

There was a production department decision on this many many years ago. I think by @chrisdavenport

avatar PhilETaylor
PhilETaylor - comment - 21 May 2021

/facepalm

avatar PhilETaylor
PhilETaylor - comment - 21 May 2021

Search for @deprecated ... soooo painful to see.

Screenshot 2021-05-21 at 13 08 40

avatar PhilETaylor PhilETaylor - change - 21 May 2021
Status Pending Closed
Closed_Date 0000-00-00 00:00:00 2021-05-21 12:09:29
Closed_By PhilETaylor
Labels Added: ?
avatar PhilETaylor PhilETaylor - close - 21 May 2021
avatar brianteeman
brianteeman - comment - 21 May 2021
avatar PhilETaylor
PhilETaylor - comment - 21 May 2021

Shall I point out all the ways that section is wrong haha...

An element can be marked as being deprecated in a new minor release or the first release of a new major version. Advice on how to amend code that is currently using an element that is marked as deprecated MUST be added to the documentation.

And yet there are 1000s without this documentation after the tag

Previously deprecated elements that are no longer used in the product itself MUST be removed in the first version of a new major series but MUST NOT be removed in a minor or patch release.

Like 4.0.0...... yet there are loads that have not been and we are about to go to RC.

Code that is deprecated will have a @deprecated tag added to the appropriate docblock and it will be noted in the release notes.

Never happens.

Add a Comment

Login with GitHub to post a comment