[wp-trac] [WordPress Trac] #47896: Docs: add missing argument in the wp_list_categories function docblock

WordPress Trac noreply at wordpress.org
Sun Aug 18 20:20:45 UTC 2019


#47896: Docs: add missing argument in the wp_list_categories function docblock
-----------------------------------+------------------------------
 Reporter:  audrasjb               |       Owner:  (none)
     Type:  defect (bug)           |      Status:  new
 Priority:  normal                 |   Milestone:  Awaiting Review
Component:  Taxonomy               |     Version:
 Severity:  normal                 |  Resolution:
 Keywords:  has-patch 2nd-opinion  |     Focuses:  docs
-----------------------------------+------------------------------

Comment (by birgire):

 Replying to [comment:3 audrasjb]:
 > Hi @birgire , these are also good considerations :)
 >
 > While I understand the idea for not duplicating documentation bits, I'd
 say that in this case, that would be better to refer to the existing
 documentation, like, for example:
 > {{{
 > /**
 >  * Display or retrieve the HTML list of categories.
 >  *
 >  * @see get_terms() for the full list of arguments.
 >  *
 >  …
 > }}}

 I think I would suggest referring to {{{get_categories()}}} instead as
 it's explicitly used.

 I remember the discussion when we adjusted the {{{wp_tag_cloud}}}
 documentation:

 https://developer.wordpress.org/reference/functions/wp_tag_cloud/

 in #42019. That's one way to refer to the other supported input arguments.

 Similarly for {{{get_categories()}}} input arguments:

 https://core.trac.wordpress.org/browser/tags/5.2.2/src/wp-
 includes/category.php#L9

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/47896#comment:6>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list