Add experiment note

ShaunLawrie · Mar 20, 2024 · 9a1cb6e · 9a1cb6e
1 parent 5b388de
commit 9a1cb6e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/PwshSpectreConsole/public/demo/Start-SpectreRecording.ps1 b/PwshSpectreConsole/public/demo/Start-SpectreRecording.ps1
@@ -12,7 +12,8 @@ function Start-SpectreRecording {
             Starts a recording of the current console output. This can be used to record all of the spectre console interactions in a PowerShell session.  
             I've used this to record the examples on the docs help site.
             :::caution
-            This is experimental.
+            This is experimental.  
+            Experimental features are unstable and subject to change.
             :::
         .PARAMETER Width
             The width of the recording.

diff --git a/PwshSpectreConsole/public/demo/Stop-SpectreRecording.ps1 b/PwshSpectreConsole/public/demo/Stop-SpectreRecording.ps1
@@ -8,7 +8,8 @@ function Stop-SpectreRecording {
             Stops a recording of the current console output and returns the recording.  
             I've used this to record the examples on the docs help site.
             :::caution
-            This is experimental.
+            This is experimental.  
+            Experimental features are unstable and subject to change.
             :::
         .PARAMETER Title
             The title of the recording, only used for asciinema recordings.

diff --git a/PwshSpectreConsole/public/images/Get-SpectreImageExperimental.ps1 b/PwshSpectreConsole/public/images/Get-SpectreImageExperimental.ps1
@@ -7,7 +7,8 @@ function Get-SpectreImageExperimental {
     This function loads an image from a file and displays it in the console using block characters and ANSI escape codes. The image is scaled to fit within the specified maximum width while maintaining its aspect ratio. If the image is an animated GIF, each frame is displayed in sequence.  
     The images rendered by this experimental function are not handled by Spectre Console, it's using a PowerShell script to render the image in a higher resolution than Spectre.Console does by using half-block characters.
     :::caution
-    This is experimental.
+    This is experimental.  
+    Experimental features are unstable and subject to change.
     :::
 
     .PARAMETER ImagePath