[wp-trac] [WordPress Trac] #26252: Hook Docs: wp-admin/includes/update.php

[WordPress Trac]

#26252: Hook Docs: wp-admin/includes/update.php
--------------------------+------------------------------
 Reporter:  stevenkword   |       Owner:  DrewAPicture
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |
--------------------------+------------------------------
Changes (by DrewAPicture):

 * keywords:  has-patch => needs-patch


Comment:

 [attachment:26252.diff] is a great start. Here are some notes:
 Both hooks:
 * Use lowercase variables in the `@param` docs. They may be capitalized in
 the array keys, but we're aiming for consistency with the other hook docs,
 e.g. `$Name` becomes `$name`, `$PluginURI` becomes `$pluginuri` or
 `$plugin_uri`, and so on.
 * The hash notation indents should be four spaces, not tabs. This goes for
 the array descriptions and all inner `@type` lines.
 * The long descriptions should describe what the dynamic portion of the
 hook names, in this case `$file` refers to. Even a simple example for each
 would help.
 * Are these hooks Multisite specific? If not, we should avoid pigeon-
 holing them to the Network Admin in the long description

 `in_theme_update_message-{$file}` hook:
 * Use the short description to describe where/when the hook fires, not
 why. Something like the following: "Fires at the end of each row in the
 theme updates table."

 `in_plugin_update_message-{$file}` hook:
 * Same as the first hook. Try to describe where/when the hook fires, not
 why. "Fires at the end of each row in the plugin updates table."

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