[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):

 [attachment:wp-admin-plugin-install.25229.diff] — @naomicbush:
 * Add spacing to filters and actions per coding standards while you're
 documenting them, e.g. `apply_filters( 'hook', 'callback' )` vs
 apply_filters('hook', 'callback')`.
 * `'install_plugins_pre_' . $tab`, rather than generalizing that install
 or plugin information are tabs, specify that the action fires before each
 tab is loaded. Add a long description if you think it will make it
 clearer.
 * Other than that, looks good.

 [attachment:wp-admin-includes-plugin-install.25229.diff] — @naomicbush:
 * "Requested information" is a little too succinct. Maybe be a little more
 descriptive.
 * Space out actions and filters per coding standards
 * "Merely add a result" isn't going to work. Each filter or action should
 be viewed as independent. "Merely add a result" makes sense in the context
 of the file and other hooks but not independently.
 * Remove all functional docs changes. Let's just stick with hooks and
 filters for now. If you'd like to submit a functional docs patch
 separately, create a new ticket on the Inline Docs component and we'll
 discuss those there.

 [attachment:wp-links-opml.diff] — @netweb:
 * `opml_head` action: Space it out per coding standards, and drop the `?>`
 to a new line. Also, the short description should describe when it fires,
 e.g. "Fires in the OPML head." or something
 * Anytime you find yourself writing "Allows you to filter something", just
 use "Filter something". "Allows you to" makes an implication about
 ''how'', instead of ''what''
 * `@param` lines 54, 69 need a period after the short description
 * Spacing issues with the docblock for `link_title` L#64

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