Is it possible to provide a custom title for an example section in the Powershell script help string?

user_80002 0
Viewed 36

Right now the example sections are numbered. I would like them to have my own custom titles.

I have a PS script with the help here - https://gist.github.com/MarkKharitonov/91698caf8c695902eacde2b6c7825bf1

There are three examples there. The first one is:

.EXAMPLE
    cd "D:\tmp\cantestr52 - 06-09-2017"
    #############
    # The User Config File
    #############

    PS D:\tmp\cantestr52 - 06-09-2017> cat C:\Users\mkharitonov\runcdb.config.ps1
    $Sosex = "E:\Utils\sosex\64\sosex.dll"
    $CDB = "e:\Program Files (x86)\Windows Kits\10\Debuggers\x64\cdb.exe"
    $SymbolsCache = "E:\Symbols"

And it is rendered like this:

-------------------------- EXAMPLE 1 --------------------------

C:\PS>cd "D:\tmp\cantestr52 - 06-09-2017"

#############
# The User Config File
#############

PS D:\tmp\cantestr52 - 06-09-2017> cat C:\Users\mkharitonov\runcdb.config.ps1
$Sosex = "E:\Utils\sosex\64\sosex.dll"
$CDB = "e:\Program Files (x86)\Windows Kits\10\Debuggers\x64\cdb.exe"
$SymbolsCache = "E:\Symbols"

Not ideal. I would like The User Config File to be the example title. However, I cannot just have it immediately under .EXAMPLE, because then PowerShell prepends it with PS C:> - see Powershell does not render my script help correctly

Is it possible?

powershell
1 Answers
Related