MsgCollector: documentation updates after review

Author: jrfnl

src/Util/MsgCollector.php

@@ -194,7 +194,7 @@ private function prefixAll($messages)
      * Add a message type prefix to a message.
      *
      * @param string $message The message text.
-     * @param int    $type    The type of error.
+     * @param int    $type    The type of message.
      *
      * @return string
      */

tests/Core/Util/MsgCollector/MsgCollectorTest.php

@@ -44,7 +44,7 @@ public function testAddingNonStringMessageResultsInException($message)
         }
 
         $msgCollector = new MsgCollector();
-        $msgCollector->add($message, MsgCollector::NOTICE);
+        $msgCollector->add($message);
 
     }//end testAddingNonStringMessageResultsInException()
 
@@ -69,7 +69,7 @@ public function dataAddingNonStringMessageResultsInException()
 
 
     /**
-     * Verify that non-string "messages" are rejected with an exception.
+     * Verify that passing a message type which is not one of the predefined types is rejected with an exception.
      *
      * @param mixed $type The invalid "type" to pass.
      *
@@ -126,6 +126,7 @@ public function dataAddingMessageWithUnsupportedMessageTypeResultsInException()
      * deprecations) messages.
      *
      * @param array<string, int> $messages The messages to display.
+     *                                     Key is the message, value is the error level.
      * @param bool               $expected The expected function output.
      *
      * @dataProvider dataContainsBlockingErrors
@@ -194,6 +195,7 @@ public function dataContainsBlockingErrors()
      * - The messages use the appropriate OS-specific EOL character.
      *
      * @param array<string, int> $messages The messages to display.
+     *                                     Key is the message, value is the error level.
      * @param string             $expected The expected exception message.
      *
      * @dataProvider dataDisplayingNonBlockingMessages
@@ -298,6 +300,7 @@ public function dataDisplayingNonBlockingMessages()
      * - The messages use the appropriate OS-specific EOL character.
      *
      * @param array<string, int> $messages The messages to display.
+     *                                     Key is the message, value is the error level.
      * @param string             $expected The expected exception message.
      *
      * @dataProvider dataDisplayingBlockingErrors
@@ -373,7 +376,7 @@ public function dataDisplayingBlockingErrors()
 
 
     /**
-     * Verify and safeguard that adding the same message twice is accepted.
+     * Verify and safeguard that adding the same message twice is accepted when messages have different error levels.
      *
      * Note: have multiple messages with the exact same text is not great for conveying information
      * to the end-user, but that's not the concern of the MsgCollector class.
@@ -397,7 +400,7 @@ public function testNonUniqueMessagesWithDifferentErrorLevelAreAccepted()
 
 
     /**
-     * Verify and safeguard that adding the same message twice is accepted.
+     * Verify and safeguard that adding the same message twice is accepted when messages have the same error level.
      *
      * Note: have multiple messages with the exact same text is not great for conveying information
      * to the end-user, but that's not the concern of the MsgCollector class.
@@ -520,6 +523,7 @@ public function dataDisplayOrderHandling()
      *
      * @param \PHP_CodeSniffer\Util\MsgCollector $collector The error cache object.
      * @param array<string, int>                 $messages  The error messages to add to the cache.
+     *                                                      Key is the message, value is the error level.
      *
      * @return void
      */