[wp-trac] [WordPress Trac] #26052: Hook Docs: wp-admin/includes/class-wp-links-list-table.php

[WordPress Trac]

#26052: Hook Docs: wp-admin/includes/class-wp-links-list-table.php
----------------------------+------------------------------
 Reporter:  JoshuaAbenazer  |       Owner:  kpdesign
     Type:  defect (bug)    |      Status:  reviewing
 Priority:  normal          |   Milestone:  Awaiting Review
Component:  Inline Docs     |     Version:
 Severity:  normal          |  Resolution:
 Keywords:  needs-patch     |
----------------------------+------------------------------
Changes (by kpdesign):

 * keywords:  has-patch => needs-patch


Comment:

 @JoshuaAbenazer: Thanks for the patch. :)

 Just a few things:

 - Rather than breaking up the existing line, insert the docblock just
 above it.

 {{{
 default:
         [insert doc block here]
         ?>
         <td <?php echo $attributes ?>><?php do_action(
 'manage_link_custom_column', $column_name, $link->link_id ); ?></td>
 }}}

 - Use tabs to indent each line from the left gutter, and spaces inside the
 doc block.
 - Short description should be "Fires for each registered custom link
 column."
 - @since should be 2.1.0 (use the 3-digit version number).
 - There should be a period after the description in both @param lines.
 - Use a docs-specific variable for the link ID, such as `$link_id`.
 - Make sure there is no extra whitespace at the end of each line in the
 block.

 Could you make these changes, and submit a new patch please?

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