[wp-trac] [WordPress Trac] #30315: Improve inline documentation of widgets API

[WordPress Trac]

#30315: Improve inline documentation of widgets API
--------------------------+-------------------
 Reporter:  ericlewis     |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  4.1
Component:  Widgets       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |     Focuses:  docs
--------------------------+-------------------

Comment (by ericlewis):

 Although I understand that it would be nice to get `@since` tags, I
 disagree with the approach that docs is an all-or-no-commit venture. More
 documentation is better than no documentation, and improved documentation
 is better than existing documentation. If someone wants to update just the
 description of a single parameter to a function, I think they should be
 able to make that contribution without any more barrier to contribution.

 Here, I needed to figure out some widgets internals for my day job, so I
 added the documentation that I needed to get me through, and hope(/know)
 it will benefit other WordPress developers. If I'm responsible for adding
 `@since` tags whenever I touch any documentation, I'm not going to
 contribute as much.

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