platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

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

Open sdwheeler opened this issue 3 years ago • 0 comments

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.:

  • https://github.com/PowerShell/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/New-PSSession.md

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

  • https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/new-pssession

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 avatar Jul 07 '22 20:07 sdwheeler