[wp-meta] [Making WordPress.org] #2331: Code Reference: Incorrect notice for deprecated functions with no @see

Making WordPress.org noreply at wordpress.org
Tue Dec 13 13:39:47 UTC 2016


#2331: Code Reference: Incorrect notice for deprecated functions with no @see
---------------------------+-----------------------
 Reporter:  dimadin        |      Owner:
     Type:  defect         |     Status:  new
 Priority:  normal         |  Milestone:
Component:  Developer Hub  |   Keywords:  has-patch
---------------------------+-----------------------
 Deprecated functions that don't have `@see` always display version when
 they were deprecated instead of description that follows after that
 version.

 For example, function `get_editable_user_ids()` has no `@see` but has
 description in `@deprecated` (`Use get_users()`). Instead, in notice, you
 can see "3.1.0 instead.":
 https://developer.wordpress.org/reference/functions/get_editable_user_ids/

 Also, same type of notice is displayed for functions that have no
 alternative functions at all, like `_relocate_children()`:
 https://developer.wordpress.org/reference/functions/_relocate_children/

 Problem is that from [2816] `$deprecated['content']` is used where
 `$deprecated['description']` should have been used.
 `$deprecated['content']` always holds version when function is deprecated
 while `$deprecated['description']` exists if there is something after
 version number.

 See #1647.

 Closes https://github.com/WordPress/phpdoc-parser/issues/183.

--
Ticket URL: <https://meta.trac.wordpress.org/ticket/2331>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org


More information about the wp-meta mailing list