J3 Issue ?
avatar mbabker
mbabker
7 May 2019

There are over 150 deprecated elements in the code that is parsed for the https://api.joomla.org website (basically the libraries directory) that have no descriptions about the deprecation. Ideally, every deprecated element (or its parent if we're talking about an entire class having been deprecated) should have some form of description either pointing to an alternative or indicating that the functionality will not exist or be supported by Joomla in the future (I put the or there because of the number of CMS package deprecations where the "replacement" is installing a package via Composer, though the CMS isn't providing that API anymore Joomla still has an alternative).

Likewise, there are a lot of deprecation notices that need updates (such as those for social APIs where the Framework packages are now deprecated as well, or saying that JKeychain is deprecated without a replacement is inaccurate as the joomla/keychain Framework package is alive and well).

Lastly, with the migration to namespaced classes, it would be ideal for the doc blocks to be updated with the correct references; I'll leave this note to only target deprecations for now to stay in line with the issue's theme but ideally this is a global review sooner or later.

avatar mbabker mbabker - open - 7 May 2019
avatar joomla-cms-bot joomla-cms-bot - change - 7 May 2019
Labels Added: ?
avatar joomla-cms-bot joomla-cms-bot - labeled - 7 May 2019
avatar franz-wohlkoenig franz-wohlkoenig - change - 8 May 2019
Status New Discussion
avatar franz-wohlkoenig franz-wohlkoenig - change - 15 May 2019
Labels Added: J4 Issue
avatar franz-wohlkoenig franz-wohlkoenig - labeled - 15 May 2019
avatar franz-wohlkoenig franz-wohlkoenig - change - 15 May 2019
Title
Deprecations without descriptions
[4.0] Deprecations without descriptions
avatar franz-wohlkoenig franz-wohlkoenig - edited - 15 May 2019
avatar mbabker
mbabker - comment - 15 May 2019

@franz-wohlkoenig This isn't a 4.0 issue. Right now it's "only" a 3.x issue in the sense that a documentation run hasn't been done on the 4.0 branch yet, but there are probably similar doc block deficiencies in 4.0 as well. Either way, most of the deprecation notices should be fixed on 3.x first.

avatar franz-wohlkoenig franz-wohlkoenig - change - 15 May 2019
Labels Added: J3 Issue
Removed: J4 Issue
avatar franz-wohlkoenig franz-wohlkoenig - unlabeled - 15 May 2019
avatar franz-wohlkoenig franz-wohlkoenig - labeled - 15 May 2019
avatar franz-wohlkoenig franz-wohlkoenig - change - 15 May 2019
Title
[4.0] Deprecations without descriptions
Deprecations without descriptions
avatar franz-wohlkoenig franz-wohlkoenig - edited - 15 May 2019
avatar mbabker mbabker - change - 19 Jul 2019
Status Discussion Closed
Closed_Date 0000-00-00 00:00:00 2019-07-19 15:53:17
Closed_By mbabker
avatar mbabker mbabker - close - 19 Jul 2019

Add a Comment

Login with GitHub to post a comment