[wp-trac] [WordPress Trac] #25229: Add Inline Docs for Hooks

[WordPress Trac]

#25229: Add Inline Docs for Hooks
----------------------------+------------------
 Reporter:  rzen            |       Owner:
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  3.7
Component:  Inline Docs     |     Version:
 Severity:  normal          |  Resolution:
 Keywords:                  |
----------------------------+------------------

Comment (by DrewAPicture):

 @Frank Klein: [attachment:author-template.2.patch] is looking better. Some
 notes:
 * For the `'the_author_' . $field` filter, `$field` is part of the filter
 hook, not a parameter. So maybe just explain that that portion of the hook
 name is dynamic in a long description
 * `@param string HTML link` needs a period at the end
 * `$author_id The ID of a user.` should probably sub 'user' for 'author'
 * The `$is_multi_author` parameter description should probably be
 something more like "Whether $is_multi_author should evaluate as true"

 Thanks for splitting the original patch apart :)

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