Skip to content

Display full help with 'help' function #5195

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
adityapatwardhan merged 4 commits into from
Nov 6, 2017
Merged

Display full help with 'help' function #5195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0fd0ece
Display full help on non-Windows systems
rkeithhill Oct 21, 2017
1eb85f2
Add tests for full view change to help function
rkeithhill Oct 27, 2017
be043d5
Addess PR feedback on skip approach
rkeithhill Oct 31, 2017
a1510a9
help function displays full help on all platforms
rkeithhill Nov 3, 2017
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: 5 additions & 0 deletions src/System.Management.Automation/engine/InitialSessionState.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4253,6 +4253,11 @@ .FORWARDHELPCATEGORY Cmdlet
[switch]
${ShowWindow})

# Display the full help topic by default but only for the AllUsersView parameter set.
if (($psCmdlet.ParameterSetName -eq 'AllUsersView') -and !$Full) {
$PSBoundParameters['Full'] = $true
}

#Set the outputencoding to Console::OutputEncoding. More.com doesn't work well with Unicode.
$outputEncoding=[System.Console]::OutputEncoding

Expand Down
18 changes: 17 additions & 1 deletion test/powershell/engine/Help/HelpSystem.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ Describe "Get-Help should find pattern help files" -Tags "CI" {
}
}

Describe "Get-Help should find pattern alias" -Tags "CI" {
Describe "Get-Help should find pattern alias" -Tags "CI" {
# Remove test alias
AfterAll {
Remove-Item alias:\testAlias1 -ErrorAction SilentlyContinue
Expand All @@ -300,5 +300,21 @@ Describe "Get-Help should find pattern help files" -Tags "CI" {
$help.Category | Should BeExactly "Alias"
$help.Synopsis | Should BeExactly "Where-Object"
}
}

Describe "help function uses full view by default" -Tags "CI" {
It "help should return full view without -Full switch" {
$gpsHelp = (help Microsoft.PowerShell.Management\Get-Process)
$gpsHelp | Where-Object {$_ -cmatch '^PARAMETERS'} | Should Not BeNullOrEmpty
}

It "help should return full view even with -Full switch" {
$gpsHelp = (help Microsoft.PowerShell.Management\Get-Process -Full)
$gpsHelp | Where-Object {$_ -cmatch '^PARAMETERS'} | Should Not BeNullOrEmpty
}

It "help should not append -Full when not using AllUsersView parameter set" {
$gpsHelp = (help Microsoft.PowerShell.Management\Get-Process -Parameter Name)
$gpsHelp | Where-Object {$_ -cmatch '^PARAMETERS'} | Should BeNullOrEmpty
}
}