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

WordPress Trac noreply at wordpress.org
Wed May 17 04:09:10 UTC 2017


#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 has-patch  |     Focuses:  docs
--------------------------------------+-------------------

Comment (by mrahmadawais):

 Replying to [comment:25 westonruter]:
 > The changes to the phpdoc comments before each `require_once` in `class-
 wp-customize-control.php` shouldn't be necessary. In fact, I don't think
 phpdoc comments are even appropriate here.

 I made those changes in line with the Doc Standards for
 [https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/php/#3-requires-and-includes Requires and
 Includes]. I hope that clarifies it.

 Is this ticket now ready to be committed? I think it's a good addition —
 in the next major version we can also take a pass on JS files.

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


More information about the wp-trac mailing list