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

Comment (by westonruter):

 @mrahmadawais you're right about:

 > I made those changes in line with the Doc Standards for Requires and
 Includes. I hope that clarifies it.

 The changes to the `@access` tags on class methods however doesn't seem
 right. In looking at [https://make.wordpress.org/core/handbook/best-
 practices/inline-documentation-standards/php/#1-functions-class-methods
 Functions & Class Methods] it says:

 > access: Only use for standalone functions if private. If the function is
 private it will be output with a message stating its intention for
 internal use.

 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.

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