[skip ci] Update docs

ShaunLawrie · Mar 12, 2024 · 8038d2f · 8038d2f
1 parent f83ae92
commit 8038d2f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/...Console.Docs/src/content/docs/reference/Images/Get-SpectreImageExperimental.mdx b/...Console.Docs/src/content/docs/reference/Images/Get-SpectreImageExperimental.mdx
@@ -18,7 +18,8 @@ import getspectreimageexperimentalExample2 from '../../../../assets/examples/get
 
 ### Description
 
-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 with a configurable delay between frames.
+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 with a configurable delay between frames.  
+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.
 :::

diff --git a/...ectreConsole.Docs/src/content/docs/reference/Writing/Get-SpectreEscapedText.mdx b/...ectreConsole.Docs/src/content/docs/reference/Writing/Get-SpectreEscapedText.mdx
@@ -29,7 +29,7 @@ See [https://spectreconsole.net/markup](https://spectreconsole.net/markup) for m
 > EXAMPLE 1
 
 ```powershell
-$data = "][[][]]][[][][]["
+$data = "][[][red]]][[/][][]["
 Format-SpectrePanel -Title "Unescaped data" -Data "I want escaped $($data | Get-SpectreEscapedText) [yellow]and[/] [red]unescaped[/] data"
 ```
 <TerminalPlayer