Add paging support to Get-Help
#13374
Conversation
adityapatwardhan
requested review from
anmenaga,
daxian-dbw and
TravisEz13
as code owners
ghost
assigned
| // The output from GetHelpOutput has all the item in the output. | ||
| // We just need to store it and then write to Pager later. | ||
| // No need to append them. | ||
| _multiItemPagerBuffer = helpText; |
There was a problem hiding this comment.
Design question about Pager - is it a common use case? If so should it be the Pager feature?
There was a problem hiding this comment.
We have had a discussion about it. We would like to get some feedback from the community if they see value in making this a built in function.
There was a problem hiding this comment.
Please do. Out-Host -Paging is significantly less useful. Having a native pager in PS would let folks utilize it regardless of the host OS and what external paging utils may or may not be available.
There was a problem hiding this comment.
if it relies on the alternate character buffer, then it has reduced applicability
There was a problem hiding this comment.
Can you expand on that a bit for those of us not intimately familiar with the APIs in play here? 🙂
There was a problem hiding this comment.
Opened issue #13405 to discuss if the Pager should be made more general purpose. Lets continue discussion over there.
daxian-dbw
requested review from
JamesWTruher
and removed request for
daxian-dbw
|
@JamesWTruher Can you please review this PR? |
| // The output from GetHelpOutput has all the item in the output. | ||
| // We just need to store it and then write to Pager later. | ||
| // No need to append them. | ||
| _multiItemPagerBuffer = helpText; |
There was a problem hiding this comment.
if it relies on the alternate character buffer, then it has reduced applicability
Co-authored-by: James Truher [MSFT] <jimtru@microsoft.com>
|
@daxian-dbw Is this ready to merge? |
|
@adityapatwardhan I notice there is still an open comment thread: #13374 (comment). I'm waiting for that to be resolved. |
|
@daxian-dbw I have opened an issue to discuss making Pager more general purpose. #13405 |
daxian-dbw
added
the
CL-General
|
🎉 Handy links: |
…owerShell#13374)" This reverts commit 485ec44.
|
#13519 reverts this change |
|
🎉 Handy links: |
PR Summary
The PR uses
Microsoft.PowerShell.Pagernuget package to add paging support toGet-Help.To see output of
Get-Helpon alternate screen buffer, use-Pagedswitch.PR Context
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.-Pagedparameter ofGet-HelpMicrosoftDocs/PowerShell-Docs#6448