Improve method documentation for WP_Widget_Calendar

[DrewAPicture]

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

Class: WP_Widget_Calendar
File: wp-includes/widgets/class-wp-widget-calendar.php

[leemon]

Improve method documentation

[leemon]

Correct patch. Ignore the previous one.

[SergeyBiryukov]

Hi @leemon, thanks for the patch! Just a note, attachments don't trigger email notifications, so it's a good idea to leave a comment whenever you upload something.

[leemon]

Thanks for the info. I didn't know that.

[leemon]

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

34017.2.patch

[DrewAPicture]

Hi @leemon,

Thanks for the patch!

As mentioned in #34027:

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. The idea is to avoid simple copy pasta and actually get specific :-)

[leemon]

Updated method descriptions

[DrewAPicture]

In 34619:

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

Props leemon.
Fixes #34017. See #34013.