Tests: Document object-value comparisons in abilities API tests.

Explain why four assertions retain assertEquals(): the expected abilities are separate instances whose properties are compared by value.

Developed in: #13903

Props huzaifaalmesbah.
See #64895.


git-svn-id: https://develop.svn.wordpress.org/trunk@64032 602fd350-edb4-49c9-b593-d223f7449a82

Author: lancewillett

tests/phpunit/tests/abilities-api/wpAbilitiesRegistry.php

@@ -515,6 +515,7 @@ public function test_register_incorrect_already_registered_ability() {
 	public function test_register_new_ability() {
 		$result = $this->registry->register( self::$test_ability_name, self::$test_ability_args );
 
+		// Keep assertEquals() because the objects are intentionally compared by value.
 		$this->assertEquals(
 			new WP_Ability( self::$test_ability_name, self::$test_ability_args ),
 			$result

tests/phpunit/tests/abilities-api/wpRegisterAbility.php

@@ -519,6 +519,7 @@ public function test_unregister_existing_ability() {
 
 		$result = wp_unregister_ability( self::$test_ability_name );
 
+		// Keep assertEquals() because the objects are intentionally compared by value.
 		$this->assertEquals(
 			new WP_Ability( self::$test_ability_name, self::$test_ability_args ),
 			$result
@@ -581,6 +582,7 @@ static function ( $instance ) use ( $name, $args ) {
 
 		$result = wp_get_ability( $name );
 
+		// Keep assertEquals() because the objects are intentionally compared by value.
 		$this->assertEquals(
 			new WP_Ability( $name, $args ),
 			$result,
@@ -699,6 +701,8 @@ public function test_get_all_registered_abilities() {
 		);
 
 		$result = wp_get_abilities();
+
+		// Keep assertEquals() because the objects are intentionally compared by value.
 		$this->assertEquals( $expected, $result );
 	}
 }