[wp-trac] [WordPress Trac] #28298: Improve inline docs for functional default arguments throughout core

[WordPress Trac]

#28298: Improve inline docs for functional default arguments throughout core
----------------------------+-----------------------------
 Reporter:  DrewAPicture    |       Owner:
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  Future Release
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:                  |     Focuses:  docs
----------------------------+-----------------------------

Comment (by coffee2code):

 Handled the remaining hash notation-related fixes for `src/wp-
 includes/widgets.php`:

 * [attachment:28298.register_sidebar.diff] converts `register_sidebar()`
 default argument docs to hash notation
 * [attachment:28298.register_sidebars.diff] adds default argument docs for
 `register_sidebars()`
 * [attachment:28298.the_widget.diff] adds default argument docs for
 `the_widget()`. Also minor formatting tweaks to the existing @param docs
 (to include: adding “Optional.”, adding ending periods, capitalizing
 descriptions, aligning descriptions, removing “@return void”)

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