Skip to content

Add Aliases to the properties shown up for a parameter in Get-Help #20994

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.

Sign up for GitHub

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

Merged
daxian-dbw merged 2 commits into from
Jan 9, 2024
Merged

Add Aliases to the properties shown up for a parameter in Get-Help #20994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45ba8c7
Add 'Aliases' to the properties shown up for a parameter in 'Get-Help'
daxian-dbw Jan 4, 2024
c750e8b
Add test for the help content formatting change
daxian-dbw Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/System.Management.Automation/FormatAndOutput/DefaultFormatters/Help_format_ps1xml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,14 +350,17 @@ internal static IEnumerable<ExtendedTypeDefinition> GetFormatData()
.AddNewline()
.AddText(HelpDisplayStrings.ParameterPosition)
.AddScriptBlockExpressionBinding(@" ", selectedByScript: @"($_.position -eq $()) -or ($_.position -eq '')", customControl: control7)
.AddScriptBlockExpressionBinding(@"$_.position", selectedByScript: "$_.position -ne $()")
.AddScriptBlockExpressionBinding(@"$_.position", selectedByScript: "$_.position -ne $()")
.AddNewline()
.AddText(HelpDisplayStrings.ParameterDefaultValue)
.AddPropertyExpressionBinding(@"defaultValue")
.AddNewline()
.AddText(HelpDisplayStrings.AcceptsPipelineInput)
.AddPropertyExpressionBinding(@"pipelineInput")
.AddNewline()
.AddText(HelpDisplayStrings.ParameterAliases)
.AddPropertyExpressionBinding(@"aliases")
.AddNewline()
.AddText(HelpDisplayStrings.AcceptsWildCardCharacters)
.AddPropertyExpressionBinding(@"globbing", customControl: MamlTrueFalseShortControl)
.AddNewline()
Expand Down
9 changes: 9 additions & 0 deletions test/powershell/engine/Help/HelpSystem.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,15 @@ Describe "Validate that get-help works for CurrentUserScope" -Tags @('CI') {
$help.Description | Out-String | Should -Match $cmdletName
$help.Examples | Out-String | Should -Match $cmdletName
}

It "Validate 'Aliases' is present in help content formatting" {
## The parameter help content should be formatted with the following section:
## Accept pipeline input? xxxx
## Aliases NoOverwrite
## Accept wildcard characters? xxxx
$output = Get-Help Import-Module -Parameter NoClobber | Out-String
$output | Should -Match "Accept pipeline input\?.*\n\s+Aliases\s+NoOverwrite.*\n\s+Accept wildcard characters\?.*"
}
}
}

Expand Down