[wp-trac] [WordPress Trac] #39671: Customize: Further improve inline documentation

[WordPress Trac]

#39671: Customize: Further improve inline documentation
-----------------------------------------------------+-------------------
 Reporter:  westonruter                              |       Owner:
     Type:  defect (bug)                             |      Status:  new
 Priority:  normal                                   |   Milestone:  4.8
Component:  Customize                                |     Version:
 Severity:  normal                                   |  Resolution:
 Keywords:  good-first-bug dev-feedback needs-patch  |     Focuses:  docs
-----------------------------------------------------+-------------------
Changes (by grapplerulrich):

 * focuses:   => docs


Comment:

 @4nickpick This looks good. I see you copied the documentation of the
 properties in `class-wp-customize-partial.php` :)

 For `$settings` I would mention what happens if undefined e.g. "IDs for
 settings tied to the partial. If undefined, `$id` will be used.". I am not
 sure if we can somehow explain how the array should be structured. From my
 understanding they a list of IDs.

 We should also add that the default for `$type` is `default`,
 `$container_inclusive` is `false` and `$fallback_refresh` is `true`.

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