-
Notifications
You must be signed in to change notification settings - Fork 1.7k
PowerShell about_ help files do not display synopsis due to incompatible formatting #3268
Copy link
Copy link
Closed
Labels
area-helpsystemArea - Help services (pipeline, get/update-help)Area - Help services (pipeline, get/update-help)resolution-externalStatus - closed by customer or outside resourceStatus - closed by customer or outside resource
Description
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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area-helpsystemArea - Help services (pipeline, get/update-help)Area - Help services (pipeline, get/update-help)resolution-externalStatus - closed by customer or outside resourceStatus - closed by customer or outside resource