[wp-trac] [WordPress Trac] #25638: Hooks Docs: wp-includes/default-widgets.php

[WordPress Trac]

#25638: Hooks Docs: wp-includes/default-widgets.php
-----------------------------+------------------------------
 Reporter:  janw.oostendorp  |       Owner:  kpdesign
     Type:  defect (bug)     |      Status:  reviewing
 Priority:  normal           |   Milestone:  Awaiting Review
Component:  Inline Docs      |     Version:
 Severity:  normal           |  Resolution:
 Keywords:  has-patch        |
-----------------------------+------------------------------

Comment (by dd32):

 {{{
 /** This action|filter is documented in /wp-includes/default-widgets.php
 (this file) */
 }}}

 FWIW, based on http://make.wordpress.org/core/handbook/inline-
 documentation-standards/php-documentation-standards/#4-1-duplicate-hooks
 * you should also change `action|filter` to `action` or `filter` depending
 on if it's an `apply_filters()` / `do_action()` hook you're documenting
 * file path shouldn't begin with /
 * suffixing (this file) isn't needed, as it's primarily going to be used
 for automated parsing into the new documentation site when launched.

 Based on http://make.wordpress.org/core/handbook/inline-documentation-
 standards/php-documentation-standards/#5-2-multi-line-comments you'll also
 want to wrap the descriptions in some of the longer blocks (such as for
 the `widget_archives_dropdown_args` filter)

 Not intended to be a full review, just pointing out the few small things
 that I noticed.

--
Ticket URL: <http://core.trac.wordpress.org/ticket/25638#comment:4>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software