[wp-trac] [WordPress Trac] #25495: Hook Docs: wp-includes/class-wp.php

[WordPress Trac]

#25495: Hook Docs: wp-includes/class-wp.php
--------------------------+------------------------------
 Reporter:  dougwollison  |       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:

 Hi, thanks for the new patch. Looks pretty good, just a couple of things
 to tweak.

 Some notes on [attachment:25495-patch.diff]:
 * All short descriptions and parameter descriptions should end with a
 period.
 * Add whitespacing per coding standards to the lines containing the
 `apply_filters()` or `do_action()` calls (a rare opportunity to do this!).


 `do_parse_request` filter:
 * "Test if parse_request should be done." should follow the suggested
 language of "Filter <this thing>"
 * The first parameter needs a description with an ending period. With
 booleans, we often use language something like "Whether to <something>".
 * Move the `@since` line above the parameter lines.

 `query_vars` filter:
 * In the long description, I'd suggest wrapping to a new line after the
 word "prior".

 `query_string` filter:
 * Period missing on the short description
 * `@depreciated` should be `@deprecated`, wrap the hook names in single
 quotes on this line.

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