search

PowerShell / platyPS

Write PowerShell External Help in Markdown
MIT License
778 stars 152 forks source link

PlatyPS is creating and adding PSDSC -help.xml to the maml/cab files for the PowerShellGet module #221

Closed TaraMeyer closed 7 years ago

TaraMeyer commented 8 years ago

Wondering if this behavior exists because of the Find-DscResource being part of the PowerShellGet as well as PSDSC module.

PowershellGet.zip capture

Steps to reproduce:

Expected behavior:

A help.xml for the PowerShellGet module is created and dropped in the outputpath specified Actual behavior

The PSDesiredStateConfiguration-help.xml and the PSGet-help.xml are created in and dropped in the outputpath specified

Environment data:

PowerShell 5.0 PlatyPS 0.6.1

Screenshot attached and MDs for you to test on your own.

vors commented 8 years ago

Interesting. Thank you, Tara for reporting the issue. It boils down to the fact that in Find-DscResource.md the help file name metadata is incorrect.

external help file: PSDesiredStateConfiguration-help.xml

This field is auto-propagated by platyPS and it's likely a bug in the initialization. To workaround the problem you can edit this metadata manually.

TaraMeyer commented 8 years ago

Thank you for the workaround, Sergei.

joeyaiello commented 7 years ago

Closing given that this was fixed in the help itself.