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

WordPress Trac noreply at wordpress.org
Fri May 19 05:34:55 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 westonruter):

 Replying to [comment:30 mrahmadawais]:
 > 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.

 Actually, I interpret the guidelines to mean that `@access` should be used
 for ''functions'' not ''methods''.

 > 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?

 So I think essentially all of the `@access` tags actually should be
 removed from the docblocks for methods in these classes. I've tried to get
 confirmation on this from #docs:
 https://wordpress.slack.com/archives/C02RP4WU5/p1495151067056851

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


More information about the wp-trac mailing list