[wp-trac] [WordPress Trac] #34027: Improve method documentation for WP_Widget_Text

[WordPress Trac]

#34027: Improve method documentation for WP_Widget_Text
----------------------------------------+-------------------
 Reporter:  DrewAPicture                |       Owner:
     Type:  defect (bug)                |      Status:  new
 Priority:  normal                      |   Milestone:  4.4
Component:  Widgets                     |     Version:
 Severity:  normal                      |  Resolution:
 Keywords:  good-first-bug needs-patch  |     Focuses:  docs
----------------------------------------+-------------------
Changes (by DrewAPicture):

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


Comment:

 Hi @leemon,

 Thanks for the patch!

 Just a couple of notes:

 * Let's go with the vernacular of something like "the current {type}
 widget instance" instead of "a particular instance of a widget". Being
 general in the `WP_Widget` base class is fine, but in this context, we can
 be more specific. For example:

 {{{
  * Handles updating settings for the current Text widget instance.
 }}}

 * Notice I inserted the type of widget, in this case "Text", and more
 specifically mentioned updating the ''settings'' which is what the
 `update()` method does.
 * The same sort of advice goes along with any other method in the class

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