[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        |   Keywords:  needs-patch good-first-bug
  Focuses:                |
--------------------------+----------------------------------------
 We need to do another pass on the customizer code to ensure that inline
 documentation is added to both PHP and JS. This is building on #27534,
 #27065, #21303 among others.

 For example, per @grapplerulrich:

 > I would like to see parts of the documentation improved. For example: In
 WP_Customize_Selective_Refresh::add_partial( $id, $args ) there is no
 inline documentation what values can be provided for teh args. Only by
 reading the code I am able to work out what the variables are but it is
 not so easy as the args are all of the public variables in the class.

 https://make.wordpress.org/design/2017/01/13/what-makes-a-great-
 customization-experience/#comment-24907

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