Apply suggestions from code review

Co-authored-by: Weston Ruter <[email protected]>

Author: huzaifaalmesbah

src/wp-content/themes/twentyfourteen/functions.php

@@ -756,7 +756,7 @@ function twentyfourteen_register_block_patterns() {
  *
  * @global WP_Customize_Manager $wp_customize Customizer object.
  *
- * @return bool True if the site is being previewed in the Customizer, false otherwise.
+ * @return bool Whether the site is being previewed in the Customizer.
  */
 if ( ! function_exists( 'is_customize_preview' ) ) :
 	function is_customize_preview() {

src/wp-content/themes/twentynineteen/inc/template-functions.php

@@ -11,7 +11,7 @@
  * Adds custom classes to the array of body classes.
  *
  * @param array $classes Classes for the body element.
- * @return array The filtered body class list.
+ * @return string[] The filtered body class list.
  */
 function twentynineteen_body_classes( $classes ) {
 

src/wp-content/themes/twentyseventeen/inc/template-functions.php

@@ -11,7 +11,7 @@
  * Adds custom classes to the array of body classes.
  *
  * @param array $classes Classes for the body element.
- * @return array Filtered body classes with theme-specific additions.
+ * @return string[] Filtered body classes with theme-specific additions.
  */
 function twentyseventeen_body_classes( $classes ) {
 	// Add class of group-blog to blogs with more than 1 published author.

src/wp-content/themes/twentyseventeen/inc/template-tags.php

@@ -184,7 +184,7 @@ function twentyseventeen_front_page_section( $partial = null, $id = 0 ) {
 /**
  * Returns true if a blog has more than 1 category.
  *
- * @return bool True if the blog has more than 1 category, false otherwise.
+ * @return bool Whether the blog has more than 1 category.
  */
 function twentyseventeen_categorized_blog() {
 	$category_count = get_transient( 'twentyseventeen_categories' );

src/wp-content/themes/twentytwenty/classes/class-twentytwenty-customize.php

@@ -459,7 +459,7 @@ public static function sanitize_select( $input, $setting ) {
 		 * @since Twenty Twenty 1.0
 		 *
 		 * @param bool $checked Whether or not a box is checked.
-		 * @return bool True if the checkbox is checked, false otherwise.
+		 * @return bool Whether the checkbox is checked.
 		 */
 		public static function sanitize_checkbox( $checked ) {
 			return ( ( isset( $checked ) && true === $checked ) ? true : false );

src/wp-content/themes/twentytwenty/functions.php

@@ -304,7 +304,7 @@ function twentytwenty_menus() {
  * @since Twenty Twenty 1.0
  *
  * @param string $html The HTML output from get_custom_logo() (core function).
- * @return string Custom logo HTML with retina support.
+ * @return string|false Custom logo HTML or false if not available.
  */
 function twentytwenty_get_custom_logo( $html ) {
 
@@ -635,7 +635,7 @@ function twentytwenty_block_editor_settings() {
  * Overwrite default more tag with styling and screen reader markup.
  *
  * @param string $html The default output HTML for the more tag.
- * @return string The filtered HTML of the more tag, wrapped in a wrapper div.
+ * @return string The the read more link wrapped in a `div`.
  */
 function twentytwenty_read_more_tag( $html ) {
 	return preg_replace( '/<a(.*)>(.*)<\/a>/iU', sprintf( '<div class="read-more-button-wrap"><a$1><span class="faux-button">$2</span> <span class="screen-reader-text">"%1$s"</span></a></div>', get_the_title( get_the_ID() ) ), $html );

src/wp-content/themes/twentytwenty/inc/template-tags.php

@@ -148,7 +148,7 @@ function twentytwenty_site_description( $display = true ) {
  * @since Twenty Twenty 1.0
  *
  * @param object $comment Comment data.
- * @return bool True if the comment is by the post author, false otherwise.
+ * @return bool Whether the comment is by the post author.
  */
 function twentytwenty_is_comment_by_post_author( $comment = null ) {
 

src/wp-content/themes/twentytwentyone/inc/template-functions.php

@@ -13,7 +13,7 @@
  * @since Twenty Twenty-One 1.0
  *
  * @param array $classes Classes for the body element.
- * @return array Filtered body classes with theme-specific additions.
+ * @return string[] Body classes with theme-specific additions.
  */
 function twenty_twenty_one_body_classes( $classes ) {
 
@@ -43,7 +43,7 @@ function twenty_twenty_one_body_classes( $classes ) {
  * @since Twenty Twenty-One 1.0
  *
  * @param array $classes An array of CSS classes.
- * @return array Filtered post classes with 'entry' class added.
+ * @return string[] Post classes with 'entry' class added.
  */
 function twenty_twenty_one_post_classes( $classes ) {
 	$classes[] = 'entry';