From 9a1cb6eeab7e9a62d9b01187ffacbe3dd3f4240f Mon Sep 17 00:00:00 2001 From: "Shaun Lawrie (via GitHub Actions)" Date: Wed, 20 Mar 2024 23:21:42 +1300 Subject: [PATCH] Add experiment note --- PwshSpectreConsole/public/demo/Start-SpectreRecording.ps1 | 3 ++- PwshSpectreConsole/public/demo/Stop-SpectreRecording.ps1 | 3 ++- .../public/images/Get-SpectreImageExperimental.ps1 | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/PwshSpectreConsole/public/demo/Start-SpectreRecording.ps1 b/PwshSpectreConsole/public/demo/Start-SpectreRecording.ps1 index 8b09eacf..0af73ce7 100644 --- 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 index fd3e1885..f605fec6 100644 --- 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 index e0ae8fe5..3badbe51 100644 --- 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