[wp-trac] [WordPress Trac] #26206: PHPDoc Updates for wp-includes/class-wp-theme.php (was: Hook Docs: wp-includes/class-wp-theme.php)

[WordPress Trac]

#26206: PHPDoc Updates for wp-includes/class-wp-theme.php
--------------------------+------------------------------
 Reporter:  richard2222   |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Inline Docs   |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |
--------------------------+------------------------------
Changes (by kpdesign):

 * version:  trunk =>


Old description:

> Attached patch for functions
>     _name_sort
>   _name_sort_i18n
> in wp-includes/class-wp-theme.php

New description:

 Attached patch for functional doc changes in wp-includes/class-wp-
 theme.php.

--

Comment:

 '''@richard2222:''' Thanks for the patch. :)

 Your changes are to functional docs, rather than documenting the two hooks
 in the file (`wp_cache_themes_persistently` and `allowed_themes`).

 I've changed the subject of this ticket to reflect that, and this patch
 will be reviewed in that context.

 Please read the PHP Documentation Standard section on
 [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#4-hooks-actions-and-filters documenting
 Hooks (Actions and Filters)] to familiarize yourself with how the hook doc
 blocks and duplicate hooks should be formatted.

 `wp_cache_themes_persistently` is being documented in the patch on #25588,
 so it would be considered a duplicate hook in this file.

 The `allowed_themes` hook would need to be fully documented per the
 standard.

 If you would like to also document the hooks, create a new patch
 containing just the hook doc changes, then open a new ticket for that
 patch please. :)

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