#26206 closed defect (bug) (invalid)
PHPDoc Updates for wp-includes/class-wp-theme.php
Reported by: |
|
Owned by: | |
---|---|---|---|
Milestone: | Priority: | normal | |
Severity: | normal | Version: | |
Component: | Themes | Keywords: | has-patch close |
Focuses: | docs | Cc: |
Description (last modified by )
Attached patch for functional doc changes in wp-includes/class-wp-theme.php.
Attachments (2)
Change History (7)
#2
@
11 years ago
- Description modified (diff)
- Summary changed from Hook Docs: wp-includes/class-wp-theme.php to PHPDoc Updates for wp-includes/class-wp-theme.php
- Version trunk deleted
@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 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. :)
#3
follow-up:
↓ 4
@
11 years ago
- Component changed from Inline Docs to Themes
- Focuses docs added
- Keywords close added
I don't think there is much value in documenting the parameters of a PHP sorting function, which is also a private class method.
diff file