Fix examples

ShaunLawrie · Feb 25, 2024 · 5184117 · 5184117
1 parent aea67c1
commit 5184117
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/PwshSpectreConsole/public/progress/Add-SpectreJob.ps1 b/PwshSpectreConsole/public/progress/Add-SpectreJob.ps1
@@ -20,8 +20,8 @@ function Add-SpectreJob {
     The PowerShell job to add to the context.
 
     .EXAMPLE
-    # This is an example of how to use the Add-SpectreJob function to add two jobs to a jobs list that can be passed to Wait-SpectreJobs.
-    Invoke-SpectreCommandWithProgress -Title "Waiting" -ScriptBlock {
+    # This is an example of how to use the Add-SpectreJob function to add two jobs to a jobs list that can be passed to Wait-SpectreJobs when you're inside Invoke-SpectreCommandWithProgress.
+    Invoke-SpectreCommandWithProgress -ScriptBlock {
         param (
             $Context
         )

diff --git a/PwshSpectreConsole/public/progress/Wait-SpectreJobs.ps1 b/PwshSpectreConsole/public/progress/Wait-SpectreJobs.ps1
@@ -22,7 +22,7 @@ function Wait-SpectreJobs {
 
     .EXAMPLE
     # Waits for two jobs to complete
-    Invoke-SpectreCommandWithProgress -Title "Waiting" -ScriptBlock {
+    Invoke-SpectreCommandWithProgress -ScriptBlock {
         param (
             $Context
         )

diff --git a/PwshSpectreConsole/public/writing/Write-SpectreCalender.ps1 b/PwshSpectreConsole/public/writing/Write-SpectreCalender.ps1
@@ -32,9 +32,11 @@ function Write-SpectreCalendar {
     Hides the header of the calendar. (Date)
 
     .EXAMPLE
+    # This example shows how to use the Write-SpectreCalendar function with an events table defined as a hashtable in the command.
     Write-SpectreCalendar -Date 2024-07-01 -Events @{'2024-07-10' = 'Beach time!'; '2024-07-20' = 'Barbecue' }
 
     .EXAMPLE
+    # This example shows how to use the Write-SpectreCalendar function with an events table as an object argument.
     $events = @{
         '2024-01-10' = 'Hello World!'
         '2024-01-20' = 'Hello Universe!'