[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 19:46:35 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:  needs-patch   |     Focuses:  docs
--------------------------+------------------------------

Comment (by birgire):

 Hi @audrasjb

 yes, these are good considerations.

 The way I see it now, is that it's good if we can **avoid duplicating the
 documentation** of input arguments if  possible and only document it if
 it's a part of the corresponding function's code base. Then e.g. refer to
 the other places where the other "hidden" but supported input arguments
 are documented.

 So I would suggest not document {{{include}}} in
 {{{wp_list_categories()}}} as it's not part of it's code base, like
 {{{exclude}}}.

 I might be wrong about this, but just wanted to mention it here :-)

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


More information about the wp-trac mailing list