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

[WordPress Trac]

#25508: Hooks Docs: wp-includes/admin-bar.php
--------------------------+------------------------------
 Reporter:  swissspidy    |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |
--------------------------+------------------------------
Changes (by kpdesign):

 * keywords:  has-patch => needs-patch


Comment:

 @swissspidy: Thanks for the patch. :)

 Just a few things that need fixed:

 General:
 - All short/long descriptions and @param descriptions need periods at the
 end.

 `wp_admin_bar_class`:
 - Change @param to `@param WP_Admin_Bar The WP_Admin_Bar instance, passed
 by reference.`

 `wp_before_admin_bar_render`:
 - Remove the blank line after @since, as there's no parameters to be
 listed.

 `show_admin_bar`:
 - s/wheter/whether in short description and @param description.
 - Change long description to say that `show_admin_bar` is the recommended
 way to hide the toolbar.
 - Existing long description should be moved to the @param description,
 like:

 {{{
 * @param bool $show_admin_bar Whether the admin bar should be shown.
 Default 'false'.
 *                             The user's display preference is used for
 logged in users.
 }}}

 Could you make these changes and upload a new patch please? :)

 Also, please do not overwrite your existing patch. If you use the same
 filename, Trac will append a number to the filename to indicate it's a new
 version. We like to keep all patch versions for the ticket history.

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