Improve method documentation for WP_Widget_Text

[DrewAPicture]

Note: This is part of the effort in #34013 to improve method documentation to all core widget classes

Class: WP_Widget_Text
File: wp-includes/widgets/class-wp-widget-text.php

[leemon]

Improve method documentation

[leemon]

Added patch to improve the method docs for the widget(), update(), form(), and __construct() methods in the WP_Widget_Text class.

34027.patch

[DrewAPicture]

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

[leemon]

Thanks for the clarification, Drew! You may have guessed that I'm a newbie.

Before creating the new patches, I'd like to be sure about the strings to use:

__construct(): Creates a new {type} widget instance.
widget(): Echoes the current {type} widget instance content.
update(): Handles updating settings for the current {type} widget instance.
form(): Outputs the current {type} widget instance settings update form.

What do you think?

[DrewAPicture]

Replying to leemon:

Thanks for the clarification, Drew! You may have guessed that I'm a newbie.

Before creating the new patches, I'd like to be sure about the strings to use:

__construct(): Creates a new {type} widget instance.
widget(): Echoes the current {type} widget instance content.
update(): Handles updating settings for the current {type} widget instance.
form(): Outputs the current {type} widget instance settings update form.

What do you think?

Works for me :-)

[leemon]

Updated method descriptions

[DrewAPicture]

Thanks @leemon, this looks great!

[DrewAPicture]

In 34609:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Text.

(first!) Props leemon.
Fixes #34027.