Cleared TODO comments across all files - task #171

classes/class-twentynineteen-svg-icons.php

@@ -1,14 +1,12 @@
 <?php
 /**
- * TODO: File doc comment.
+ * SVG Icons class
  *
  * @package WordPress
  * @subpackage Twenty_Nineteen
  */
 
 /**
- * SVG Icons class.
- *
  * This class is in charge of displaying SVG icons across the site.
  *
  * Place each <svg> source on its own array key, without adding the
@@ -17,6 +15,8 @@
  *
  * All icons are assumed to have equal width and height, hence the option
  * to only specify a `$size` parameter in the svg methods.
+ *
+ * @since 1.0.0
  */
 class TwentyNineteen_SVG_Icons {
 

classes/class-twentynineteen-walker-comment.php

@@ -1,13 +1,15 @@
 <?php
 /**
- * TODO: File doc comment.
+ * Custom comment walker for this theme
  *
  * @package WordPress
  * @subpackage Twenty_Nineteen
  */
 
 /**
- * TODO: Class doc comment.
+ * This class outputs custom comment walker for HTML5 friendly WordPress comment and threaded replies.
+ *
+ * @since 1.0.0
  */
 class TwentyNineteen_Walker_Comment extends Walker_Comment {
 
@@ -52,7 +54,6 @@ protected function html5_comment( $comment, $depth, $args ) {
 
 							/* translators: %s: comment author link */
 							printf(
-								/* translators: TODO comment on placeholders */
 								__( '%s <span class="screen-reader-text says">says:</span>' ),
 								sprintf( '<b class="fn">%s</b>', get_comment_author_link( $comment ) )
 							);

footer.php

@@ -18,7 +18,6 @@
 		<div class="site-info">
 			<a class="site-name" href="<?php echo esc_url( home_url( '/' ) ); ?>" rel="home"><?php bloginfo( 'name' ); ?></a>,
 			<a href="<?php echo esc_url( __( 'https://wordpress.org/', 'twentynineteen' ) ); ?>" class="imprint">
-				<?php /* translators: TODO comment on placeholders */ ?>
 				<?php printf( __( 'Proudly powered by %s', 'twentynineteen' ), 'WordPress' ); ?>.
 			</a>
 			<?php

inc/icon-functions.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * SVG icons related functions.
+ * SVG icons related functions
  *
  * @package WordPress
  * @subpackage Twenty_Nineteen

inc/template-functions.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Functions which enhance the theme by hooking into WordPress.
+ * Functions which enhance the theme by hooking into WordPress
  *
  * @package WordPress
  * @subpackage Twenty_Nineteen

inc/template-tags.php

@@ -71,9 +71,7 @@ function twentynineteen_estimated_read_time() {
 		if ( 0 === $minutes ) {
 			return null;
 		}
-		/* translators: TODO comment on placeholders */
 		$datetime_attr = sprintf( '%dm 0s', $minutes );
-		/* translators: TODO comment on placeholders */
 		$read_time_text = sprintf( _nx( '%s Minute', '%s Minutes', $minutes, 'Time to read', 'twentynineteen' ), $minutes );
 		/* translators: 1: SVG icon. 2: Reading time label, only visible to screen readers. 3: The [datetime] attribute for the <time> tag. 4: Estimated reading time text, in minutes. */
 		printf(
@@ -217,35 +215,30 @@ function twentynineteen_human_time_diff( $from, $to = '' ) {
 			if ( $hours <= 1 ) {
 				$hours = 1;
 			}
-			/* translators: TODO comment on placeholders */
 			$since = sprintf( _n( '%s hour ago', '%s hours ago', $hours, 'twentynineteen' ), $hours );
 		} elseif ( $diff < WEEK_IN_SECONDS && $diff >= DAY_IN_SECONDS ) {
 			$days = round( $diff / DAY_IN_SECONDS );
 			if ( $days <= 1 ) {
 				$days = 1;
 			}
-			/* translators: TODO comment on placeholders */
 			$since = sprintf( _n( '%s day ago', '%s days ago', $days, 'twentynineteen' ), $days );
 		} elseif ( $diff < 30 * DAY_IN_SECONDS && $diff >= WEEK_IN_SECONDS ) {
 			$weeks = round( $diff / WEEK_IN_SECONDS );
 			if ( $weeks <= 1 ) {
 				$weeks = 1;
 			}
-			/* translators: TODO comment on placeholders */
 			$since = sprintf( _n( '%s week ago', '%s weeks ago', $weeks, 'twentynineteen' ), $weeks );
 		} elseif ( $diff < YEAR_IN_SECONDS && $diff >= 30 * DAY_IN_SECONDS ) {
 			$months = round( $diff / ( 30 * DAY_IN_SECONDS ) );
 			if ( $months <= 1 ) {
 				$months = 1;
 			}
-			/* translators: TODO comment on placeholders */
 			$since = sprintf( _n( '%s month ago', '%s months ago', $months, 'twentynineteen' ), $months );
 		} elseif ( $diff >= YEAR_IN_SECONDS ) {
 			$years = round( $diff / YEAR_IN_SECONDS );
 			if ( $years <= 1 ) {
 				$years = 1;
 			}
-			/* translators: TODO comment on placeholders */
 			$since = sprintf( _n( '%s year ago', '%s years ago', $years, 'twentynineteen' ), $years );
 		}
 

inc/ui-icons.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * TODO: File doc comment.
+ * Custom Icons for this theme
  *
  * @package WordPress
  * @subpackage Twenty_Nineteen

js/customizer.js

@@ -6,7 +6,6 @@
  * Contains handlers to make Theme Customizer preview reload changes asynchronously.
  */
 
-// TODO: Remove "jshint ignore:line" below once $ is actually used.
 ( function( $ ) { // jshint ignore:line
 
 } )( jQuery );

template-parts/header/entry-header.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * TODO: File doc comment.
+ * Displays the post header
  *
  * @package WordPress
  * @subpackage Twenty_Nineteen

template-parts/header/site-branding.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * TODO: File doc comment.
+ * Displays header site branding
  *
  * @package WordPress
  * @subpackage Twenty_Nineteen

template-parts/post/author-info.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * TODO: File doc comment.
+ * The template for displaying Author info
  *
  * @package WordPress
  * @subpackage Twenty_Nineteen

template-parts/post/discussion-meta.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * TODO: File doc comment.
+ * The template for displaying Current Discussion on posts
  *
  * @package WordPress
  * @subpackage Twenty_Nineteen
@@ -16,15 +16,12 @@
 	/* translators: %1(X responses)$s from %2(X others)$s */
 	$meta_label = sprintf(
 		'%1$s from %2$s.',
-		/* translators: TODO comment on placeholders */
 		sprintf( _n( '%d response', '%d responses', $discussion->responses, 'twentynineteen' ), $discussion->responses ),
-		/* translators: TODO comment on placeholders */
 		sprintf( _n( '%d other', '%d others', $discussion->commenters, 'twentynineteen' ), $discussion->commenters )
 		);
 } elseif ( $comments_number > 0 ) {
 	/* Show comment count if not enough discussion information */
 
-	/* translators: TODO comment on placeholders */
 	$meta_label = sprintf( _n( '%d Comment', '%d Comments', $comments_number, 'twentynineteen' ), $comments_number );
 } else {
 	$meta_label = __( 'No comments', 'twentynineteen' );