Show-Command should expose help info, especially parameter help for hints on filling in good values by Matthew Reynolds [MSFT]

Active

Type:	Suggestion
ID:	780635
Opened:	3/4/2013 4:51:05 PM
Access Restriction:	Public

Workaround(s)

view

The usefulness of Show-Command to be a GUI wrapper around a script/function to allow less expert workers to perform tasks is limited by the fact that there is no way to communicate hints to the user (e.g., via parameter help messages) on how to fill in good values.

There should be a way to have help info like synopsis appear at the top of the Show-Command UI and have parameter help strings appear in conjunction with each parameter.

Details (expand)

Always Happens

No, this is new to the most recent version

function Install-Widgets{
<#
.SYNOPSIS
Use this command to install Widgets
.PARAMETER ComputerName
Enter one or more computer names (comma separated) on which to install the widgets
.PARAMETER FluxCapacitorFactor = 3
Leave this at 3 except for advanced users.
#>
param(
[string[]]$computername = "localhost"
, [int]$FluxCapacitorFactor = 3
)
}

Show-Command Install-Widgets
)

}

Should somehow expose help information as part of Show-Command UI to help people get the values right. Does not.

0 attachments

Microsoft