[wp-trac] [WordPress Trac] #25498: Hooks Docs: wp-admin/includes/schema.php

[WordPress Trac]

#25498: Hooks Docs: wp-admin/includes/schema.php
--------------------------+------------------------------
 Reporter:  johnafish     |       Owner:  kpdesign
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |
--------------------------+------------------------------

Comment (by kpdesign):

 @jonafish: Thanks for the patch. :)

 A few things I noticed that need fixed:

 - Please use tabs to indent the doc block from the left gutter rather than
 spaces (when needed).
 - Indent the doc block at the same level as the action or filter:

 {{{
         /**
          * Fires before creating WordPress options and setting their
 default values.
          *
          * @since 2.6.0
          */
         do_action( 'populate_options' );
 }}}

 - The @since version for `populate_actions` should be 2.6.0. A good
 reference to use is [http://adambrown.info/p/wp_hooks/hook Adam Brown's
 Hook Reference] for finding the version a hook was added. If you are
 unable to find it, just use `@since Unknown` and we can try to trace it.
 - It's okay to space out the action or filter line to bring it inline with
 the coding standards. For example, `do_action('populate_options');` can be
 changed to `do_action( 'populate_options' );`. That is the only whitespace
 fixes that should be done.

 Could you make these changes and resubmit the patch? :)

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