From 1226afc5a4e494e08b3796d5691193d6d6290fb2 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sat, 4 Feb 2023 15:16:13 +0000 Subject: [PATCH] Docs: Use consistent format for the `@return` tags in `_wp_object_name_sort_cb()` and `_wp_object_count_sort_cb()`. Both functions are used as a callback for `uasort()`. Follow-up to [36013], [55214]. See #57358, #56792. git-svn-id: https://develop.svn.wordpress.org/trunk@55222 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/category-template.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/wp-includes/category-template.php b/src/wp-includes/category-template.php index 969ea9c67c..dcc32c417f 100644 --- a/src/wp-includes/category-template.php +++ b/src/wp-includes/category-template.php @@ -1084,7 +1084,8 @@ function _wp_object_name_sort_cb( $a, $b ) { * * @param object $a The first object to compare. * @param object $b The second object to compare. - * @return int The count value for `$a` minus the count value for `$b` (less than, equal to, or greater than zero). + * @return int Negative number if `$a->count` is less than `$b->count`, zero if they are equal, + * or greater than zero if `$a->count` is greater than `$b->count`. */ function _wp_object_count_sort_cb( $a, $b ) { return ( $a->count - $b->count );