Changeset 56472

Timestamp:

08/25/2023 05:09:09 AM (16 months ago)

Author:

audrasjb

Message:

Docs: Improve PHPCS comments general consistency.

Props nekojonez.
See #58833.

Location:

trunk

Files:

• src/wp-includes/block-patterns.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (1 diff)
• tests/phpunit/includes/functions.php (modified) (2 diffs)
• tests/phpunit/includes/install.php (modified) (1 diff)
• tests/phpunit/includes/testcase-xml.php (modified) (2 diffs)

trunk/src/wp-includes/block-patterns.php

@@ -469 +469 @@
                     // Translate the pattern metadata.
                     $text_domain = $theme->get( 'TextDomain' );
-                    //phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.NonSingularStringLiteralContext, WordPress.WP.I18n.NonSingularStringLiteralDomain, WordPress.WP.I18n.LowLevelTranslationFunction
+                    // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.NonSingularStringLiteralContext, WordPress.WP.I18n.NonSingularStringLiteralDomain, WordPress.WP.I18n.LowLevelTranslationFunction
                     $pattern_data['title'] = translate_with_gettext_context( $pattern_data['title'], 'Pattern title', $text_domain );
                     if ( ! empty( $pattern_data['description'] ) ) {
-                        //phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.NonSingularStringLiteralContext, WordPress.WP.I18n.NonSingularStringLiteralDomain, WordPress.WP.I18n.LowLevelTranslationFunction
+                        // phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.NonSingularStringLiteralContext, WordPress.WP.I18n.NonSingularStringLiteralDomain, WordPress.WP.I18n.LowLevelTranslationFunction
                         $pattern_data['description'] = translate_with_gettext_context( $pattern_data['description'], 'Pattern description', $text_domain );
                     }

trunk/src/wp-includes/functions.php

@@ -5145 +5145 @@
     preg_match_all( $regexp, str_replace( "'", '', $input_string ), $matches );
     return strtolower( implode( '-', $matches[0] ) );
-    //phpcs:enable WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
+    // phpcs:enable WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
 }
 

trunk/tests/phpunit/includes/functions.php

@@ -119 +119 @@
         $wpdb->termmeta,
     ) as $table ) {
-        //phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+        // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
         $wpdb->query( "DELETE FROM {$table}" );
     }
@@ -127 +127 @@
         $wpdb->term_taxonomy,
     ) as $table ) {
-        //phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+        // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
         $wpdb->query( "DELETE FROM {$table} WHERE term_id != 1" );
     }

trunk/tests/phpunit/includes/install.php

@@ -65 +65 @@
 $wpdb->query( 'SET foreign_key_checks = 0' );
 foreach ( $wpdb->tables() as $table => $prefixed_table ) {
-    //phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+    // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
     $wpdb->query( "DROP TABLE IF EXISTS $prefixed_table" );
 }
 
 foreach ( $wpdb->tables( 'ms_global' ) as $table => $prefixed_table ) {
-    //phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
+    // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
     $wpdb->query( "DROP TABLE IF EXISTS $prefixed_table" );
 

trunk/tests/phpunit/includes/testcase-xml.php

@@ -70 +70 @@
      */
     public function assertXMLEquals( $expectedXml, $actualXml, $message = '' ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
-        $this->assertSame( $this->normalizeXML( $expectedXml ), $this->normalizeXML( $actualXml ), $message ); //phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
+        $this->assertSame( $this->normalizeXML( $expectedXml ), $this->normalizeXML( $actualXml ), $message ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
     }
 
@@ -87 +87 @@
      * @param string $message   Optional. Message to display when the assertion fails.
      */
-    public function assertXMLNotEquals( $expectedXml, $actualXml, $message = '' ) { //phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
-        $this->assertNotEquals( $this->normalizeXML( $expectedXml ), $this->normalizeXML( $actualXml ), $message ); //phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
+    public function assertXMLNotEquals( $expectedXml, $actualXml, $message = '' ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
+        $this->assertNotEquals( $this->normalizeXML( $expectedXml ), $this->normalizeXML( $actualXml ), $message ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase
     }
 }