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

WordPress Trac noreply at wordpress.org
Fri May 19 04:56:37 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:28 westonruter]:
 > It also seems the docs for use of `@access` on class member properties
 should also be updated to note that it shouldn't be used, as I think
 perhaps it could be a carryover from PHP 4 which used just plain `var`
 keywords and lacked any visibility at the PHP language level.


 That makes a lot of sense. Since I find them quite redundant as well.
 Though, being part of the guidelines, I did add them anyway.


 >So I think the presence of @access for all of the class methods actually
 should be removed, which also makes sense because it's entirely redundant
 with the member visibility keywords which is part of the PHP language
 itself.

 I missed that. Thanks for letting me know.

 Is there anything else left for this patch? I did take a cursory look at
 the last patch and there are certain functions for which access is not
 defined E.g. `class-wp-customize-control.php` at line # 484 the
 `render_content()` has `protected access. But that's not defined in the
 DocBlock. Should it be?

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


More information about the wp-trac mailing list