[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.7.4
Component:  Customize                               |     Version:
 Severity:  normal                                  |  Resolution:
 Keywords:  good-first-bug has-patch needs-refresh  |     Focuses:  docs
----------------------------------------------------+--------------------
Changes (by swissspidy):

 * keywords:  good-first-bug has-patch => good-first-bug has-patch needs-
     refresh


Comment:

 A quick note on [attachment:39671-2.patch]

 - We don't use `@see` for URLs, but `@link` instead.
 - Don't link to the codex.
 https://codex.wordpress.org/Theme_Customization_API  already mentions that
 one should use the handbooks.
 - `@since` annotations would be nice.

 For reference: https://make.wordpress.org/core/handbook/best-practices
 /inline-documentation-standards/php/

 The other areas mentioned above would need (separate) patches as well.

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