platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

Auto file naming should handle cdxml better

Open vors opened this issue 7 years ago • 2 comments

In her naming help video @juneb is pointing out problems with cdxml help.

Essentially, we should generate a better names in GetHelpFileName for cdxml. https://github.com/PowerShell/platyPS/blob/f24b9447afe201bc4240d8ccfda2c06bd3895b27/src/platyPS/platyPS.psm1#L1458

vors avatar Mar 07 '17 04:03 vors

The XML help file rules for CIM commands are the same as the rules for cmdlets, providers, and workflows.

The only difference is that CIM modules tend to have more CDXML files, so the task of creating one CDXML-help.xml file for each CDXML file is more cumbersome, unless it's automated.

I would change the issue name to: Name help XML files correctly for all command types. We should also have a switch for module naming (<ModuleName>-help.xml) which works on manifest modules in 4.0+ and all modules in 5.0+.

juneb avatar Mar 07 '17 16:03 juneb

This architecture and code in Microsoft.PowerShell.PlatyPS is totally different. This needs to be investigated again when v1 is released.

sdwheeler avatar May 31 '24 17:05 sdwheeler