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

[WordPress Trac]

#25662: Hook Docs: wp-admin/includes/class-wp-comments-list-table.php
--------------------------+------------------------
 Reporter:  siobhyb       |       Owner:  kpdesign
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  3.8
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |
--------------------------+------------------------

Comment (by kpdesign):

 @siobhyb: Thanks for the patch. :)

 General:
 - Please make your patch from the root directory of your SVN checkout, not
 the folder the file is in. :)
 - Make sure there is a blank space before the `*` on each line after the
 opening `/**` so that the block lines up correctly. Like this:

 {{{
 /**
  * Short description.
  *
  * @since x.x.x
  *
  * @param ...
  */
 }}}

 `comments_per_page`:
 - Align the parameters and the descriptions.
 - Change "Default is 'All'" to "Default 'All'."

 `comment_status_links`:
 - Remove long description.
 - Change @param description to "An array of fully-formed status links.
 Default 'All'. Accepts 'All', 'Pending', 'Approved', 'Spam', and 'Trash'."
 Break the line before "Accepts...", and then align it with the
 description.

 `admin_comment_types_dropdown`:
 - s/drop down/dropdown in short description.
 - Remove long description.
 - Change @param to: "@param array $comment_types An array of comment
 types. Accepts 'Comments', 'Pings'."

 `restrict_manage_comments`:
 - Change short description to "Fires just before the Filter submit button
 for comment types."
 - Remove long description.

 `manage_comments_nav`:
 - Change short description to "Fires after the Filter submit button for
 comment types."
 - Remove long description.

 `manage_comments_custom_column`:
 - Short description should be "Fires when the default column output is
 displayed for a single row."
 - Remove long description.
 - Align the parameters and the descriptions, use spaces please.

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

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