[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-includes-feed-rdf.diff] — @dustyf:
 * Space out actions and filters per coding standards while you're there
 documenting them (it's a great opportunity), e.g. `do_action( 'rdf_ns' )`
 vs `do_action('rdf_ns')`
 * Change the tense of "Fired" to "Fires" in you short descriptions
 * Nice work on this one! Make these changes and it's ready to go in :)

 [attachment:wp-includes-canonical.diff] — @dustyf:
 * Space out actions and filters per coding standards while you're there.
 * There's no hard-and-fast rule for when to wrap lines, such as in a long
 description, but generally I try to keep it at about 10-12 words per line.
 So when you wrap it, the line should start with a `* ` and a space and
 then the rest of the sentence. Like this:
 https://gist.github.com/DrewAPicture/5e1e395744060e50ba84
 * Fix the above and I'd say it's ready to go in

 [attachment:wp-includes-feed-rss.2.diff] — @dustyf:
 * Change tense of "Fired" to "Fires" in both short descriptions
 * That's it for this one, nice work.

 [attachment:wp-includes-feed-rss2.diff] — @dustyf:
 * s/Fired/Fires in short descriptions
 * Space out the actions per coding standards, e.g. `do_action( 'rss2_item'
 );` vs `do_action('rss2_item');`
 * This goes for this patch and any future ones: Anytime you find yourself
 writing "Allows filtering of whatever" just change that to "Filter
 whatever". It's about documenting '''what''' rather than '''what's
 ''possible'''.
 * `@since` should use the 3-digit, x.x.x style

 [attachment:wp-includes-feed-atom.php] — @dustyf:
 * Can you regenerate the patch in diff format?

 [attachment:wp-includes-feed-rss2-comments.diff] — @dustyf:
 * s/Fired/Fires
 * Space out actions and filters per coding standards
 * Space out the `@param` lines to align the types, variables and short
 descriptions, like this:
 https://gist.github.com/DrewAPicture/e8412b856fd7305f8ac6
 * Other than that, looks good

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