Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
sdwheeler opened this issue Jul 7, 2022 · 1 comment
Labels
Area-Schema Issue deals with the markdown or Yaml schema Issue-Enhancement Issue is more of a feature request than a bug Resolution-Fixed The issue is fixed.

Comments

@sdwheeler
Copy link
Collaborator

Summary of the new feature / enhancement

Copied from MicrosoftDocs/PowerShell-Docs#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 PowerShell/PowerShell#6856

Proposed technical implementation details (optional)

This needs to be included in the YAML conversion.

@sdwheeler sdwheeler added Issue-Enhancement Issue is more of a feature request than a bug Needs-Triage The issue is new and needs to be triaged by a work group. labels Jul 7, 2022
@sdwheeler sdwheeler added Area-Schema Issue deals with the markdown or Yaml schema and removed Needs-Triage The issue is new and needs to be triaged by a work group. labels Jul 11, 2022
@theJasonHelmick theJasonHelmick added this to the 2.0-Preview2 milestone Jul 11, 2022
@sdwheeler
Copy link
Collaborator Author

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

@sdwheeler sdwheeler added the Resolution-Fixed The issue is fixed. label May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Schema Issue deals with the markdown or Yaml schema Issue-Enhancement Issue is more of a feature request than a bug Resolution-Fixed The issue is fixed.
Projects
None yet
Development

No branches or pull requests

2 participants