PowerShell/platyPS

Command synopsis missing from Module File using New-MarkdowModuleFile with imported commands

sdwheeler opened this issue · 1 comments

Prerequisites

  • Write a descriptive title.
  • Make sure you are able to repro it on the latest released version
  • Search the existing issues.

Steps to reproduce

Create a new module markdown file by importing cmdlet files from a folder. The cmdlet markdown file contain synopsis values.

PS> $cmds = Import-MarkdownCommandHelp .\v2docs\*-*.md
PS> $cmds[0].Synopsis
Compares two **CommandHelp** objects and produces a detailed report showing the differences.
PS> New-MarkdownModuleFile -CommandHelp ($cmds) -OutputFolder . -Force

    Directory: D:\Git\PS-Src\platyPS\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/23/2024 10:55 AM           1718 Microsoft.PowerShell.PlatyPS.md

PS> $mod = Import-MarkdownModuleFile -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md
PS> $mod.CommandGroups[0].Commands

Name                       Link                          Description
----                       ----                          -----------
Compare-CommandHelp        Compare-CommandHelp.md        {{ Fill in the Description }}
Export-MamlCommandHelp     Export-MamlCommandHelp.md     {{ Fill in the Description }}
Export-MarkdownCommandHelp Export-MarkdownCommandHelp.md {{ Fill in the Description }}
Export-MarkdownModuleFile  Export-MarkdownModuleFile.md  {{ Fill in the Description }}
Export-YamlCommandHelp     Export-YamlCommandHelp.md     {{ Fill in the Description }}
Export-YamlModuleFile      Export-YamlModuleFile.md      {{ Fill in the Description }}
Import-MamlHelp            Import-MamlHelp.md            {{ Fill in the Description }}
Import-MarkdownCommandHelp Import-MarkdownCommandHelp.md {{ Fill in the Description }}
Import-MarkdownModuleFile  Import-MarkdownModuleFile.md  {{ Fill in the Description }}
Import-YamlCommandHelp     Import-YamlCommandHelp.md     {{ Fill in the Description }}
Import-YamlModuleFile      Import-YamlModuleFile.md      {{ Fill in the Description }}
New-CommandHelp            New-CommandHelp.md            {{ Fill in the Description }}
New-MarkdownCommandHelp    New-MarkdownCommandHelp.md    {{ Fill in the Description }}
Test-MarkdownCommandHelp   Test-MarkdownCommandHelp.md   {{ Fill in the Description }}

Expected behavior

Expected the synopsis to be populated from CommandHelp objects.

Actual behavior

Got placeholder text.

Error details

No response

Environment data

PlatyPS build 27d5ffe

Visuals

No response