Changeset 54741 for trunk/tests/phpunit/tests/menu/wp-nav-menu.php

Timestamp:

11/01/2022 08:15:25 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update comments in wp_nav_menu() tests per the documentation standards.

Includes:

• Fixing a few typos.
• Using the correct format for multi-line comments.
• Removing some comments that duplicate the assertion messages without providing any additional context.

Follow-up to [54478].

See #56792.

File:

• trunk/tests/phpunit/tests/menu/wp-nav-menu.php (modified) (11 diffs)

trunk/tests/phpunit/tests/menu/wp-nav-menu.php

@@ -54 +54 @@
                 );
 
-                /**
-                 * This filter is used to prevent reusing a menu item ID more that once. It cause the tests to failed
-                 * after the first one since the IDs are missing from the HTML generated by `wp_nav_menu`.
+                /*
+                 * This filter is used to prevent reusing a menu item ID more that once.
+                 * It caused the tests to fail after the first one since the IDs are missing
+                 * from the HTML generated by `wp_nav_menu()`.
                  *
-                 * To allow the tests to pass, we remove the filter before running them and add it back after
-                 * they ran ({@see Tests_Menu_wpNavMenu::tear_down_after_class()}).
+                 * To allow the tests to pass, we remove the filter before running them
+                 * and add it back after they ran ({@see Tests_Menu_wpNavMenu::tear_down_after_class()}).
                  */
                 remove_filter( 'nav_menu_item_id', '_nav_menu_item_id_use_once' );
@@ -67 +68 @@
                 wp_delete_nav_menu( self::$menu_id );
 
-                /**
-                 * This filter was removed to let the tests pass and need to be added back ({@see Tests_Menu_wpNavMenu::set_up_before_class}).
+                /*
+                 * This filter was removed to let the tests pass and needs to be added back
+                 * ({@see Tests_Menu_wpNavMenu::set_up_before_class}).
                  */
                 add_filter( 'nav_menu_item_id', '_nav_menu_item_id_use_once', 10, 2 );
@@ -76 +78 @@
 
         /**
-         * Test all menu items containing children have the CSS class `menu-item-has-children` when displaying the menu
-         * without specifying a custom depth.
+         * Tests that all menu items containing children have the CSS class `menu-item-has-children`
+         * when displaying the menu without specifying a custom depth.
          *
          * @ticket 28620
@@ -91 +93 @@
                 );
 
-                // Level 0 should be present in the HTML output and have the `menu-item-has-children` class.
                 $this->assertStringContainsString(
                         sprintf(
@@ -98 +99 @@
                         ),
                         $menu_html,
-                        'Level 0 should be present in the HTML output and have the menu-item-has-children class'
+                        'Level 0 should be present in the HTML output and have the `menu-item-has-children` class.'
                 );
 
-                // Level 1 should be present in the HTML output and have the `menu-item-has-children` class.
                 $this->assertStringContainsString(
                         sprintf(
@@ -108 +108 @@
                         ),
                         $menu_html,
-                        'Level 1 should be present in the HTML output and have the menu-item-has-children class'
+                        'Level 1 should be present in the HTML output and have the `menu-item-has-children` class.'
                 );
 
-                // Level 2 should be present in the HTML output and not have the `menu-item-has-children` class since it has no
-                // children.
                 $this->assertStringContainsString(
                         sprintf(
@@ -119 +117 @@
                         ),
                         $menu_html,
-                        'Level 2 should be present in the HTML output and not have the `menu-item-has-children` class since it has no children'
+                        'Level 2 should be present in the HTML output and not have the `menu-item-has-children` class since it has no children.'
                 );
         }
@@ -140 +138 @@
                 );
 
-                // Level 0 should be present in the HTML output and have the `menu-item-has-children` class.
                 $this->assertStringContainsString(
                         sprintf(
@@ -147 +144 @@
                         ),
                         $menu_html,
-                        'Level 0 should be present in the HTML output and have the menu-item-has-children class'
+                        'Level 0 should be present in the HTML output and have the `menu-item-has-children` class.'
                 );
 
-                // Level 1 should be present in the HTML output and not have the `menu-item-has-children` class since its the
-                // last item to be rendered.
                 $this->assertStringContainsString(
                         sprintf(
@@ -158 +153 @@
                         ),
                         $menu_html,
-                        'Level 1 should be present in the HTML output and not have the `menu-item-has-children` class since its the last item to be rendered'
+                        'Level 1 should be present in the HTML output and not have the `menu-item-has-children` class since it is the last item to be rendered.'
                 );
 
-                // Level 2 should not be present in the HTML output.
                 $this->assertStringNotContainsString(
                         sprintf(
@@ -168 +162 @@
                         ),
                         $menu_html,
-                        'Level 2 should not be present in the HTML output'
+                        'Level 2 should not be present in the HTML output.'
                 );
         }