Skip to content

Update-MarkdownCommandHelp not updating parameter description from comment-based help #751

@sdwheeler

Description

@sdwheeler

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

See TestModule.zip

  1. Edit TestModule.psm1 to remove the comment-based help for one of the two parameters.
  2. Import-Module TestModule.psd1
  3. New-MarkdownCommandHelp -ModuleInfo (gmo TestModule) -WithModulePage -OutputFolder . -Force
  4. Inspect the contents of RunTest.md - note that one parameter has a description and one does not.
  5. Remove-Module TestModule
  6. Edit TestModule.psm1 to restore the description of the parameter.
  7. Import-Module TestModule.psd1
  8. Get-Help -Full RunTest - note that both parameter have descriptions
  9. Update-MarkdownCommandHelp -Path .\TestModule\RunTest.md
  10. Inspect the contents of RunTest.md - note that one parameter has a description and one does not.

Expected behavior

Both parameters should have descriptions after step 10.

Actual behavior

Description is missing.

Error details

Environment data

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     1.0.0      preview4   Microsoft.PowerShell.PlatyPS        {Compare-CommandHelp, Export-MamlComm

Visuals

No response

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions