[wp-trac] [WordPress Trac] #41058: wp_dropdown_categories documentation is missing arguments

WordPress Trac noreply at wordpress.org
Wed Jun 21 03:37:17 UTC 2017


#41058: wp_dropdown_categories documentation is missing arguments
-------------------------+---------------------------
 Reporter:  ArnaudBan    |       Owner:  boonebgorges
     Type:  enhancement  |      Status:  reopened
 Priority:  normal       |   Milestone:  4.9
Component:  Taxonomy     |     Version:
 Severity:  normal       |  Resolution:
 Keywords:  has-patch    |     Focuses:  docs
-------------------------+---------------------------

Comment (by boonebgorges):

 We've generally moved lately toward not documenting parameters on wrapper
 functions if the default value doesn't differ from the lower-level
 function. That was my understanding when removing those lines in the doc
 block.

 The fact that items are defined in `$defaults` does not, IMHO, mean that
 those items ought to be listed in the function docblock. We pass the
 parsed `$r` array down through lower-level functions, and our `$defaults`
 declaration acts as a safeguard against lower-level changes in default
 values, not necessarily as a developer guide on how to use the function.

 That being said, I don't feel strongly. @SergeyBiryukov If you think that
 not having all of the arguments specifically spelled out here may cause
 confusion for developers, please go ahead and add them back.

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


More information about the wp-trac mailing list