[wp-trac] [WordPress Trac] #26196: Hook docs: wp-includes/class-wp-customize-section.php

[WordPress Trac]

#26196: Hook docs: wp-includes/class-wp-customize-section.php
--------------------------+------------------------------
 Reporter:  leewillis77   |       Owner:  kpdesign
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |
--------------------------+------------------------------
Changes (by kpdesign):

 * keywords:  has-patch => needs-patch
 * owner:   => kpdesign
 * status:  new => reviewing


Comment:

 @leewillis77: Thanks for the patch. :)

 Just a few things:

 General:

 - Your patch contains functional doc and hook doc changes. We are only
 doing hook docs in these tickets. Please remove the functional doc changes
 from this patch, and submit those changes in a separate patch on a new
 ticket, with the subject "PHPDoc updates for wp-includes/class-wp-
 customize-section.php".

 `customize_render_section`:
 - Change the short description to read: "Fires before rendering the
 supported Customizer sections."
 - Add a blank line between the @since and the @param line, per the example
 doc block in the [http://make.wordpress.org/core/handbook/inline-
 documentation-standards/php-documentation-standards/#4-hooks-actions-and-
 filters documentation standard].

 `'customize_render_section_' . $this->id`:
 - Change the short description to read: "Fires before rendering each
 supported Customizer section."
 - Add a long description, such as: "The dynamic portion of the hook name,
 $this->id, refers to the ID of the supported Customizer section to be
 rendered."
 - Remove the @param line. `$this->id` is part of the hook name.
 - Change the do_action line to: `do_action(
 "customize_render_section_{$this->id}" );`

 Could you make the above changes, and submit a new patch please? :)

 Note: Please don't overwrite the original patch when uploading a new one –
 it is preferred to have copies of all attachments submitted to preserve
 the history of the ticket.

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