PlatyPS XML help file names don't work on 3.0

PowerShell / platyPS

Write PowerShell External Help in Markdown

MIT License

782 stars 155 forks source link

PlatyPS XML help file names don't work on 3.0 #231

Closed juneb closed 3 years ago

juneb commented 8 years ago

PlatyPS generates module-based XML help file names that don't work on systems < PS 4.0. It also doesn't add or mention the .ExternalHelp comment keyword that's required for functions in Get-Help 3.0.

It would be best to provide an option for 3.0 file naming/#.ExternalHelp, but if you don't (and that's fine), you should, at least, explain to the user that the resulting files work only on 4.0+.

BernieWhite commented 7 years ago

@juneb To clarify, are you expecting MAML file names to be generated in the format myModule-help.xml?

vors commented 7 years ago

We should double check by experimenting. Unfortunately, I don't have access to lab environment for that. My understanding is that .ExternalHelp is needed only when the file name doesn't follow default convention, but it could be that it's 4.0+ only.

This issue should go under umbrella of 3.0 compatibility.

BernieWhite commented 6 years ago

Related to #262