-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Docs: Improve docblocks in WP_Comments_List_Table #10569
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: trunk
Are you sure you want to change the base?
Docs: Improve docblocks in WP_Comments_List_Table #10569
Conversation
Adds missing summary descriptions and improves and tags in to comply with WordPress coding standards.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
|
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. |
Co-authored-by: Weston Ruter <westonruter@gmail.com>
|
@westonruter Thank you for your review and suggestions. I’ve applied the changes you recommended. |
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
@returnand@paramtags.Testing Instructions
src/wp-admin/includes/class-wp-comments-list-table.php.Trac ticket: https://core.trac.wordpress.org/ticket/64224