[wp-trac] [WordPress Trac] #45997: Revert @ignore of _get_term_hierarchy()

WordPress Trac noreply at wordpress.org
Tue Jan 15 23:22:28 UTC 2019


#45997: Revert @ignore of _get_term_hierarchy()
--------------------------+-----------------------------
 Reporter:  coffee2code   |      Owner:  (none)
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  Taxonomy      |    Version:  4.3
 Severity:  trivial       |   Keywords:  has-patch
  Focuses:  docs          |
--------------------------+-----------------------------
 In [32453], the `@ignore` dockblock tag was added to
 `_get_term_hierarchy()` as part of a general docs cleanup for that file.
 Prior to that commit, the function was marked `@access private`, so it was
 regularly getting parsed
 [https://developer.wordpress.org/reference/functions/_get_term_hierarchy/
 into the Code Reference]. As of that commit, the parser was directed to
 ignore parsing the function. The parser doesn't  handle changes of state
 like this, so the docs for `_get_term_hierarchy()` have remained in an
 unchanged state since then. That is, the docs page for the function--as it
 was prior to the state change--is still available on the Code Ref, but no
 longer getting updated due to the `@ignore` directive. (Or it would be if
 not for the manual override to "fix" this.)

 Yes, this sounds like a problem with the parser for the Code Reference,
 and it is. '''''However''''', in this particular case, it turns out that
 marking the function to be ignored was done in error.

 In a related discussion on the matter in #meta2600, @DrewAPicture (the
 committer of [32453]) acknowledges that the change from `@access private`
 to `@ignore` was done in error (or rather, during a brief period when
 handling for this was still in flux) and that this particular change
 should get reverted.

 Attached is a patch that makes `_get_term_hierarchy()` private instead of
 ignored once again.

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/45997>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list