Display full help with 'help' function #5195
Conversation
rkeithhill
requested review from
BrucePay,
daxian-dbw,
lzybkr and
vors
as code owners
|
Any chance of something like this making it in before 6.0.0 final? It would be nice to offer full help to Linux users. And to Windows users who elect to set $env:PAGER to a better pager app. :-) |
|
@rkeithhill Sorry for the delay. I will review this today. |
|
No problem. You all had a big push to get beta.9 out. |
| # On Windows, only display the full help topic if the user has specified a PAGER app. | ||
| if (($psCmdlet.ParameterSetName -eq 'AllUsersView') -and !$Full -and (!$IsWindows -or (Test-Path env:PAGER))) { | ||
| $PSBoundParameters['Full'] = $true | ||
| } |
There was a problem hiding this comment.
Can we add a test which check the view that gets selected. It should have #FullView
(Get-Help Get-Command -Full).psobject.typenamesThere was a problem hiding this comment.
Yes, I can add that.
There was a problem hiding this comment.
BTW, to be clear, this tweak affects only the help function on Linux/macOS/Windows as well as the man alias on Windows. That function pipes through a pager so we don't get rich objects out - just text. That is why I'm using -cmatch to look for certain words that indicate it is full help.
Display full help on Windows systems where user has overriden pager with $env:PAGER. Fix PowerShell#4962
rkeithhill
force-pushed
the
rkeithhill/full-help-output
branch
from
c18eb53
to
1eb85f2
Compare
| } | ||
| } | ||
|
|
||
| It "help should not return full view without -Full switch" -Skip:(!$IsWindows) { |
There was a problem hiding this comment.
Since you already have and after all the Skip should be done over there instead of repeating it in every It.
| } | ||
| } | ||
|
|
||
| It "help should return full view without -Full switch" -Skip:(!$IsWindows) { |
There was a problem hiding this comment.
Same comment as above.
As per PowerShell Committee discussion - PowerShell#4962 (comment)
|
I think this is ready to go. The feedback from the @PowerShell/powershell-committee review was implemented in the last commit. |
adityapatwardhan
changed the title
Display full help on Windows systems where user has overriden pager with $env:PAGER.
Fix #4962