Opened 4 weeks ago
Last modified 4 days ago
#64224 new task (blessed)
Docblock improvements for 7.0
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Milestone: | 7.0 | Priority: | normal |
| Severity: | normal | Version: | |
| Component: | General | Keywords: | has-patch |
| Focuses: | coding-standards | Cc: |
Description
Previously:
Change History (23)
#1
@
4 weeks ago
- Summary changed from Dockblock improvements for 7.0 to Docblock improvements for 7.0
This ticket was mentioned in PR #9286 on WordPress/wordpress-develop by @rutujaparamane2004.
3 weeks ago
#4
- Keywords has-patch added
Trac ticket: https://core.trac.wordpress.org/ticket/64224
@SergeyBiryukov commented on PR #9286:
3 weeks ago
#5
Thanks for the PR! Merged in r61275.
This ticket was mentioned in PR #10562 on WordPress/wordpress-develop by @huzaifaalmesbah.
13 days ago
#11
### Description
This PR adds missing variable names to @param tags in Twenty Eleven, Twenty Ten, and Twenty Twenty themes.
### Changes
Twenty Eleven: category.php, functions.php
Twenty Ten: loop-attachment.php, author.php
Twenty Twenty: functions.php, inc/template-tags.php, template-parts/entry-header.php, template-parts/content-cover.php
### Testing Instructions
- Navigate to the affected files.
- Verify that the docblocks for the mentioned filters now include the variable names in the @param tags.
- Ensure no PHP errors or warnings are generated.
@noruzzaman commented on PR #10562:
10 days ago
#17
I have followed the testing instructions for Twenty Eleven, Twenty Ten, and Twenty Twenty.
The updated docblocks now include the missing parameter names ($html, $width, $height, $size, $elements, $post_types, $show_categories), and I’m not seeing any PHP warnings or notices.
This looks good to me and improves the clarity of the bundled theme docs.
This ticket was mentioned in PR #10569 on WordPress/wordpress-develop by @huzaifaalmesbah.
10 days ago
#18
## Description
Improves inline documentation for WP_Comments_List_Table in wp-admin/includes/class-wp-comments-list-table.php to align with WordPress coding standards.
## Changes
- Added missing summary descriptions.
- Improved specificity of
@returnand@paramtags.
## Testing Instructions
- Inspect
src/wp-admin/includes/class-wp-comments-list-table.php. - Verify docblocks follow standards.
@SergeyBiryukov commented on PR #10562:
10 days ago
#19
@noruzzaman commented on PR #10569:
9 days ago
#20
Thanks for the update @huzaifaalmesbah! I have gone through the changes, and everything looks cleaner and much easier to follow now. The added descriptions and improved @return / @param details definitely make the docblocks more useful.
Nice improvement overall.
@huzaifaalmesbah commented on PR #10569:
9 days ago
#21
@westonruter Thank you for your review and suggestions. I’ve applied the changes you recommended.
This ticket was mentioned in PR #10570 on WordPress/wordpress-develop by @rejaulalomkhan.
9 days ago
#22
## Description
This PR improves inline documentation in wp-admin files by adding missing parameter descriptions to function docblocks.
## Changes
- ✅ Added proper
@paramdescriptions for functions missing them - ✅ Added complete docblock for
wp_load_press_this()function - ✅ Enhanced function summary for
wp_nav_menu_max_depth() - ✅ All changes follow WordPress PHP Documentation Standards
## Files Modified
wp-admin/install.phpwp-admin/nav-menus.phpwp-admin/update-core.phpwp-admin/includes/ajax-actions.phpwp-admin/includes/class-wp-importer.php
## Testing
- [x] No functional changes, documentation only
- [x] All parameter descriptions are accurate and follow WP standards
In 61270: