Fix formatting for Set-ItResult with because, removing trailing comma and redundant because (#2591)

Co-authored-by: Tyler Richardson <[email protected]>

Author: github-actions[bot]

src/functions/Set-ItResult.ps1

@@ -94,7 +94,8 @@
     }
 
     if ($Because) {
-        [String]$message += ", because $(Format-Because $Because)"
+        [String]$formatted = Format-Because $Because
+        [String]$message += ",$($formatted.SubString(0, $formatted.Length - 1))"
     }
 
     throw [Pester.Factory]::CreateErrorRecord(

tst/functions/Set-ItResult.Tests.ps1

@@ -28,6 +28,15 @@ Describe "Testing Set-ItResult" {
         }
     }
 
+    It "Set-ItResult appends the -Because reason to the message" {
+        try {
+            Set-ItResult -Skipped -Because "we are forcing it to skip"
+        }
+        catch {
+            $_.Exception.Message | Should -Be "is skipped, because we are forcing it to skip"
+        }
+    }
+
     It "Set-ItResult can be called without -Because" {
         try {
             Set-ItResult -Skipped