<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[54808] Docs: Update comments in `wp_nav_menu()` tests per the documentation standards.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/54808">54808</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/54808","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-11-11 02:39:20 +0000 (Fri, 11 Nov 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/54478">[54478]</a>.
Props SergeyBiryukov.
Merges <a href="https://core.trac.wordpress.org/changeset/54741">[54741]</a> to the 6.1 branch.
See <a href="https://core.trac.wordpress.org/ticket/56792">#56792</a>, <a href="https://core.trac.wordpress.org/ticket/56946">#56946</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches61testsphpunittestsmenuwpnavmenuphp">branches/6.1/tests/phpunit/tests/menu/wp-nav-menu.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches61">branches/6.1/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/6.1
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/6.1 2022-11-11 02:26:02 UTC (rev 54807)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/6.1 2022-11-11 02:39:20 UTC (rev 54808)
</ins><a id="branches61"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/6.1</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.8:51889
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:54645-54646,54649,54652,54660,54662,54669,54674,54678,54686,54690,54693,54698,54706,54724,54729-54730,54733,54745,54751,54766,54768-54771,54774,54777,54782,54785-54789,54797,54799,54802-54804
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:54645-54646,54649,54652,54660,54662,54669,54674,54678,54686,54690,54693,54698,54706,54724,54729-54730,54733,54741,54745,54751,54766,54768-54771,54774,54777,54782,54785-54789,54797,54799,54802-54804
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches61testsphpunittestsmenuwpnavmenuphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.1/tests/phpunit/tests/menu/wp-nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.1/tests/phpunit/tests/menu/wp-nav-menu.php 2022-11-11 02:26:02 UTC (rev 54807)
+++ branches/6.1/tests/phpunit/tests/menu/wp-nav-menu.php 2022-11-11 02:39:20 UTC (rev 54808)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -53,12 +53,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * 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`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * 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()`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 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()}).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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()}).
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'nav_menu_item_id', '_nav_menu_item_id_use_once' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,8 +67,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public static function tear_down_after_class() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_delete_nav_menu( self::$menu_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * This filter was removed to let the tests pass and need to be added back ({@see Tests_Menu_wpNavMenu::set_up_before_class}).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * This filter was removed to let the tests pass and needs to be added back
+ * ({@see Tests_Menu_wpNavMenu::set_up_before_class}).
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'nav_menu_item_id', '_nav_menu_item_id_use_once', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,8 +77,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Test all menu items containing children have the CSS class `menu-item-has-children` when displaying the menu
- * without specifying a custom depth.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Tests that all menu items containing children have the CSS class `menu-item-has-children`
+ * when displaying the menu without specifying a custom depth.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 28620
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,7 +92,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Level 0 should be present in the HTML output and have the `menu-item-has-children` class.
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<li id="menu-item-%1$d" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-has-children menu-item-%1$d">',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -97,10 +98,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self::$lvl0_menu_item
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_html,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'Level 0 should be present in the HTML output and have the menu-item-has-children class'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'Level 0 should be present in the HTML output and have the `menu-item-has-children` class.'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Level 1 should be present in the HTML output and have the `menu-item-has-children` class.
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<li id="menu-item-%1$d" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-has-children menu-item-%1$d">',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,11 +107,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self::$lvl1_menu_item
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_html,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'Level 1 should be present in the HTML output and have the menu-item-has-children class'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'Level 1 should be present in the HTML output and have the `menu-item-has-children` class.'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Level 2 should be present in the HTML output and not have the `menu-item-has-children` class since it has no
- // children.
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<li id="menu-item-%1$d" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-%1$d">',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -118,7 +116,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self::$lvl2_menu_item
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_html,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'Level 2 should be present in the HTML output and not have the `menu-item-has-children` class since it has no children'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'Level 2 should be present in the HTML output and not have the `menu-item-has-children` class since it has no children.'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -139,7 +137,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Level 0 should be present in the HTML output and have the `menu-item-has-children` class.
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<li id="menu-item-%1$d" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-has-children menu-item-%1$d">',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -146,11 +143,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self::$lvl0_menu_item
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_html,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'Level 0 should be present in the HTML output and have the menu-item-has-children class'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'Level 0 should be present in the HTML output and have the `menu-item-has-children` class.'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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.
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<li id="menu-item-%1$d" class="menu-item menu-item-type-custom menu-item-object-custom menu-item-%1$d">',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -157,10 +152,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self::$lvl1_menu_item
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_html,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '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'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '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.'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Level 2 should not be present in the HTML output.
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringNotContainsString(
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<li id="menu-item-%d"',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -167,7 +161,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self::$lvl2_menu_item
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_html,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'Level 2 should not be present in the HTML output'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'Level 2 should not be present in the HTML output.'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>