PowerShell / platyPS

Write PowerShell External Help in Markdown
MIT License
765 stars 149 forks source link

Parameter-set names above syntax diagrams do not show up in the online versions of the help topics #578

Closed sdwheeler closed 3 months ago

sdwheeler commented 2 years ago

Summary of the new feature / enhancement

Copied from https://github.com/MicrosoftDocs/PowerShell-Docs/issues/2422

Especially with complex commands that have several parameter sets, it's important to have the parameter-set names shown above the respective syntax diagrams.

In the source code for the help topics that already seems to be the case; e.g.:

However, when the online version is rendered in the browser, the names are missing; e.g.:

Here's an example:

image

Similarly, Get-Help / -? also doesn't currently show parameter-set names - see https://github.com/PowerShell/PowerShell/issues/6856

Proposed technical implementation details (optional)

This needs to be included in the YAML conversion.

sdwheeler commented 3 months ago

This is a Yaml conversion issue that this fixed in Microsoft.PowerShell.PlatyPS v1.