add exception-example for Should (pester#2171)

kimballjohnson · May 3, 2022 · 8869115 · 8869115
1 parent c79a6fa
commit 8869115
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/functions/assertions/Should.ps1 b/src/functions/assertions/Should.ps1
@@ -103,6 +103,15 @@ function Should {
 
     .EXAMPLE
     $planets.Name | Should -Be $Expected
+
+    .EXAMPLE
+    ```powershell
+    Context "We want to ensure an exception is thrown when expected" {
+        It "Throws the exception" {
+            { Get-Application -Name Blarg } | Should -Throw "Application 'Blarg' not found"
+        }
+    }
+    ```
 #>
 
     [CmdletBinding()]