add comment based help

Author: dfinke

Public/Disable-ChatPersistence.ps1

@@ -1,3 +1,13 @@
 function Disable-ChatPersistence {
+    <#
+        .SYNOPSIS
+        Disables chat persistence.
+
+        .DESCRIPTION
+        This function disables chat persistence by setting the $ChatPersistence variable to $false.
+
+        .EXAMPLE
+        Disable-ChatPersistence
+    #>
     $Script:ChatPersistence = $false
 }

Public/Enable-ChatPersistence.ps1

@@ -1,3 +1,14 @@
 function Enable-ChatPersistence {
+    <#
+        .SYNOPSIS
+        Enables chat persistence.
+
+        .DESCRIPTION
+        The Enable-ChatPersistence function sets the $Script:ChatPersistence variable to $true, which enables chat persistence.
+
+        .EXAMPLE
+        Enable-ChatPersistence
+    #>
+
     $Script:ChatPersistence = $true
 }

Public/Get-ChatPersistence.ps1

@@ -1,3 +1,7 @@
 function Get-ChatPersistence {
+    <#
+        .SYNOPSIS
+        Retrieves the chat persistence flag.
+    #>
     $Script:ChatPersistence
 }

Public/Get-CompletionFromMessages.ps1

@@ -1,4 +1,21 @@
 function Get-CompletionFromMessages {
+    <#
+        .SYNOPSIS
+        Gets completion suggestions based on the array of messages.
+
+        .DESCRIPTION
+        The Get-CompletionFromMessages function returns completion suggestion based on the messages.
+
+        .PARAMETER Messages
+        Specifies the chat messages to use for generating completion suggestions.
+
+        .EXAMPLE
+        Get-CompletionFromMessages $(
+            New-ChatMessageTemplate -Role system 'You are a PowerShell expert'
+            New-ChatMessageTemplate -Role user 'List even numbers between 1 and 10'
+        )
+    #>
+    [CmdletBinding()]
     param(
         [Parameter(Mandatory)]
         $Messages

changelog.md

@@ -1,5 +1,8 @@
 # v0.7.6
 
+- Implement mechanism to turn on/off persistence of chat message
+- Add `Get-CompletionFromMessages` so you can get messages can be passes standalone to get the completions
+
 # v0.7.5
 
 - Fixed spaces in property names [#141](https://github.com/dfinke/PowerShellAI/issues/141)