PowerShell about_ help files do not display synopsis due to incompatible formatting

[DarwinJS]

Most powershell core about_* help files are not formatted to support the built in extraction of a synopsis.

Given that the synopsis is the ONLY metadata that can be extracted from the about_ format (which sucks - see #8230 ), these files should be correctly formatted to maximize helpfulness of help using built in features.

Steps to reproduce

Expected behavior

about_Scheduled_Jobs_Advanced     HelpFile                            Explains advanced scheduled job topics, including the file structure
about_Scheduled_Jobs_Basics       HelpFile                            Explains how to create and manage scheduled jobs.

Actual behavior

about_Types.ps1xml                HelpFile
about_Type_Operators              HelpFile
about_Updatable_Help              HelpFile
About_Using                       HelpFile

Get-Help parses only the first line of the SHORT DESCRIPTION into a synopsis.

Most of the about_* files in powershell core are formatted as (notice blank line after heading):

SHORT DESCRIPTION

    This is the short description

for the file synopsis to show up, they should be

SHORT DESCRIPTION
    This is the short description

[DarwinJS]

Hmmm - so the space between the heading at the text is consistent with all headings. If this help is coming from a conversion from source markdown - maybe it is preserving the markdown proper syntax of having a blank line - which is not compatible with get-help. Maybe powershell 6 help parser should be adjusted instead of adjusting the md conversion process.

[sdwheeler]

The blank line after the synopsis is not the issue. This appears to be an issue with they way that PlatyPS converts the MD to TXT. The output from PlatyPS if formatted with specific "headers". Get-Help is expecting that format. Since we switched to pandoc for processing the About_ files the TXT files do not have the same "headers".

[SteveL-MSFT]

This is also affecting PS7

[sdwheeler]

Link to:

• Get-Help does not display synopsis for some cmdlets PowerShell/PowerShell#9208

[sdwheeler]

This issue is being tracked in source repo.