Make WordPress Core

Opened 9 years ago

Closed 9 years ago

#34022 closed defect (bug) (fixed)

Improve method documentation for WP_Widget_Recent_Comments

Reported by: drewapicture's profile DrewAPicture Owned by: leemon's profile leemon
Milestone: 4.4 Priority: normal
Severity: normal Version:
Component: Widgets Keywords: good-first-bug has-patch
Focuses: docs Cc:


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

Class: WP_Widget_Recent_Comments
File: wp-includes/widgets/class-wp-widget-recent-comments.php

Attachments (3)

34022.patch (2.5 KB) - added by leemon 9 years ago.
Improve method documentation
34022.2.patch (2.5 KB) - added by leemon 9 years ago.
Typo fixed
34022.3.patch (2.8 KB) - added by leemon 9 years ago.
Updated method descriptions

Download all attachments as: .zip

Change History (8)

9 years ago

Improve method documentation

9 years ago

Typo fixed

#1 @SergeyBiryukov
9 years ago

  • Keywords has-patch added; needs-patch removed
  • Milestone changed from Awaiting Review to 4.4

#2 @leemon
9 years ago

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


#3 @DrewAPicture
9 years ago

  • Keywords needs-patch added; has-patch removed
  • Owner set to leemon
  • Status changed from new to assigned

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 :-)

9 years ago

Updated method descriptions

#4 @leemon
9 years ago

  • Keywords has-patch added; needs-patch removed

#5 @DrewAPicture
9 years ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 34614:

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

Also fixes a typo in the class DocBlock.

Props leemon.
Fixes #34022. See #34013.

Note: See TracTickets for help on using tickets.