-
Notifications
You must be signed in to change notification settings - Fork 156
Closed
Labels
Needs-TriageThe issue is new and needs to be triaged by a work group.The issue is new and needs to be triaged by a work group.
Milestone
Description
Prerequisites
- Write a descriptive title.
- Make sure you are able to repro it on the latest version
- Search the existing issues.
Steps to reproduce
Update-MarkdownCommandHelp
is inserting placeholder text for parameters even when the parameter has a description in the original markdown. This results in a potentially large burden on the content dev to clean those out.
Expected behavior
Placeholder text should only be used when there is no existing description.
Actual behavior
Update-MarkdownCommandHelp -Path reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-MarkdownCommandHelp.md
Example updated parameter
### -LiteralPath
Specifies a path to one or more markdown command files. The value of **LiteralPath** is used exactly
as it's typed. No characters are interpreted as wildcards. If the path includes escape characters,
enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any
characters as escape sequences.
For more information, see
[about_Quoting_Rules](/powershell/module/microsoft.powershell.core/about/about_CommonParameters).
{{ Fill LiteralPath Description }}
Error details
Environment data
RC1
Version
RC1
Visuals
No response
Metadata
Metadata
Assignees
Labels
Needs-TriageThe issue is new and needs to be triaged by a work group.The issue is new and needs to be triaged by a work group.