[wp-trac] [WordPress Trac] #26957: Hook Docs(9): wp-admin/includes/class-wp-plugins-list-table.php

[WordPress Trac]

#26957: Hook Docs(9): wp-admin/includes/class-wp-plugins-list-table.php
---------------------------------------+------------------------------
 Reporter:  nicolealleyinteractivecom  |       Owner:  kpdesign
     Type:  defect (bug)               |      Status:  reviewing
 Priority:  normal                     |   Milestone:  Awaiting Review
Component:  Plugins                    |     Version:
 Severity:  normal                     |  Resolution:
 Keywords:  needs-patch                |     Focuses:  docs
---------------------------------------+------------------------------
Changes (by DrewAPicture):

 * keywords:  has-patch => needs-patch
 * owner:   => kpdesign
 * status:  new => reviewing
 * reporter:  nicole@… => nicolealleyinteractivecom


Comment:

 Hi, thanks for the patch. Here are some notes for a second round:

 Overall:
 * All descriptions should end with periods.
 * Try to think of and document hooks as if they are being viewed
 independently of their surrounding code. This means that for each of the
 hooks in this file, we need to mention that they are fired or evaluate in
 the plugin list table and specifically where in the table, e.g. every row,
 after every row, for every custom column, etc.
 * Double check all `@since` versions for accuracy.

 `all_plugins` filter:
 * Pretty sure the `@since` version is actually 3.0.0
 * Can probably just refer to them as "plugins" here, and the description
 needs to be more specific, see the overall notes.
 * The second line of the parameter description should be be aligned with
 the first letter of the description on the first line

 `show_advanced_plugins` filter:
 * The description on the boolean parameter is missing.

 `plugin_action_links` filter:
 * Description needs a period.
 * Remove the underscore in plugin_data in the `$plugin_data` description.

 `$prefix . "plugin_action_links_$plugin_file` filter:
 * The long description should be two sentences -- the first about the
 `$prefix` portion of the hook name, the second about the `$plugin_file`
 portion.

 `plugin_row_meta` filter:
 * Description needs a period.
 * Remove underscore in plugin_data in `$plugin_data` description

 `manage_plugins_custom_column` hook:
 * Remove the underscore in plugin_data.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/26957#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform