platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

CommonParameters block not included in YAML output

Open sdwheeler opened this issue 4 years ago • 2 comments

Steps to reproduce

New-YamlHelp -Path C:\Git\PS-Docs\PowerShell-Docs\reference\7.1\Microsoft.PowerShell.Archive\Expand-Archive.md -OutputFolder .

Expected behavior

Examine the web page and see the CommonParamters paragraph (https://docs.microsoft.com/powershell/module/microsoft.powershell.archive/expand-archive#notes)

Get-Help Expand-Archive

...
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS
    System.String
        You can pipe a string that contains a path to an existing archive file.
...

Actual behavior

Examine the Yaml file created. There is no information about CommonParameters. So this information is missing from the published web page.

Environment data

0.14.1

sdwheeler avatar Jun 08 '21 19:06 sdwheeler

Related to https://github.com/MicrosoftDocs/PowerShell-Docs/issues/4484

sdwheeler avatar Jun 08 '21 20:06 sdwheeler

Found that running through the docs repo, it did not fix the issue. The fix needs to be at a lower level.

adityapatwardhan avatar Jul 19 '21 17:07 adityapatwardhan

This is included in the Microsoft.PowerShell.PlatyPS 1.0 release.

theJasonHelmick avatar May 17 '24 20:05 theJasonHelmick