platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

Update-MarkdownHelp overwrites existing descriptions for Common Parameters, Input, and Output

Open sdwheeler opened this issue 6 years ago • 2 comments

Problem 1: The Common Parameters block is overwritten when you run Update-MarkdownHelp. The default text for that block is contains a bare URL rather than a proper Markdown hyperlink.

Problem 2: When you use the -UpdateInputOutput parameter, any descriptive text that has been added to the Input and Output type sections is overwritten with blanks.

Steps to reproduce

  1. Copy files from https://github.com/PowerShell/PowerShell-Docs/tree/staging/reference/6/Microsoft.PowerShell.Archive
  2. Run Update-MarkdownHelp on that folder
  3. Inspect the changes to the cmdlet help files.

Expected behavior

Keep the existing markdown text spans.

Actual behavior

Overwrite the existing text spans.

Environment data

PS > Get-Module platyPS -list | select name,version

Name    Version
----    -------
platyPS 0.12.0

PS > $PSVersionTable

Name                           Value
----                           -----
PSVersion                      6.1.1
PSEdition                      Core
GitCommitId                    6.1.1
OS                             Microsoft Windows 10.0.17134
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

sdwheeler avatar Dec 18 '18 21:12 sdwheeler

Problem 1 probably can be solved simply by updating https://github.com/PowerShell/platyPS/blob/3cfdacec6856bd78abba726c015088744d47d865/src/Markdown.MAML/Resources/MarkdownStrings.resx#L175 to use markdown hyperlink syntax.

Problem 2 is indeed a major bummer.

vors avatar Jan 13 '19 06:01 vors

I need to create separate issues for these items.

sdwheeler avatar Feb 08 '21 17:02 sdwheeler

This is fixed in Microsoft.PowerShell.PlatyPS v1.

sdwheeler avatar May 31 '24 17:05 sdwheeler