[wp-meta] [Making WordPress.org] #3699: Deprecated methods/functions/classes/hooks should be included in the @since tax archive for the version they were deprecated in
Making WordPress.org
noreply at wordpress.org
Fri Jul 6 19:30:06 UTC 2018
#3699: Deprecated methods/functions/classes/hooks should be included in the @since
tax archive for the version they were deprecated in
---------------------------+---------------------
Reporter: pbiron | Owner: (none)
Type: enhancement | Status: new
Priority: normal | Milestone:
Component: Developer Hub | Resolution:
Keywords: 2nd-opinion |
---------------------------+---------------------
Comment (by pbiron):
Replying to [comment:1 obenland]:
> I don't know, at first glance it feels like the since archive is meant
to document functions etc that were first introduced in that release? You
could argue that it would be like showing posts in date archives for both
their publishing date and their last modified date.
Others may disagree (and I'll certainly accept that if my opinion is the
minority one), but I don't think that analogy is a good one. I think
developer documentation is different kind of animal!
Maybe the following was not the original intended use of the `@since`
archive, but one of the ways I use it is similar to how I use the
following PHP/Java documentation pages:
* [[http://php.net/manual/en/doc.changelog.php|PHP Changelog]]
* [[http://php.net/manual/en/migration72.php|Migrating from PHP 7.1.x to
PHP 7.2.x]]
* [[http://php.net/manual/en/migration72.new-functions.php|New
functions]]
* [[http://php.net/manual/en/migration72.incompatible.php|Backward
incompatible changes]]
* [[http://php.net/manual/en/migration72.deprecated.php|Deprecated
features in PHP 7.2.x]]
* etc
* [[https://docs.oracle.com/javase/10/docs/api/deprecated-
list.html|Deprecated API]]
* altho in the Java documentation case, they are not as good at making
it easy to see what has been deprecated in a specific version
That was part of the motivation behind #2847.
I came across this case of deprecations not being included in the `@since`
archive while working on an update to the patch in #2847 (and the CLI
plugin mentioned in [ticket:2847#comment:4]).
Maybe I'm the only who uses the `@since` archive in that way, but I doubt
it.
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/3699#comment:2>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list