-
Notifications
You must be signed in to change notification settings - Fork 317
Implement dynamic help for full help and parameter help #1777
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.
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
Conversation
Can you please add some screnshots of the before and after so we can see the difference? |
@adityapatwardhan Please move the dynamic help related code to a new file, you can name the file |
@daxian-dbw All feedback is addressed, please re-review. |
@ThomasNieto Added screenshots |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@adityapatwardhan We should schedule a meeting to talk about how to proceed.
One more discussion point: the formatting of the string Get-Command <command name> -parameter <paramName> | Out-String
looks pretty nice, any reason we don't want to directly use that?
8746d81
to
d40cd89
Compare
0a1f51a
to
4a09baf
Compare
@daxian-dbw - Refactored and added tests as discussed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not done with my review yet. Will continue tomorrow.
} | ||
|
||
/// <summary> | ||
/// Looks up a localized string similar to Displaying help content is not supported on this console. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure this comment is updated.
It's unfortunately that today we still have to manually update this file. Will look into do resgen similarly to PowerShell.
This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 14 days. It will be closed if no further activity occurs within 7 days of this comment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR is mostly ready. Please address the remaining comments
@adityapatwardhan There are 2 more unresolved comments from the previous review. Please take a look and address them, thanks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@adityapatwardhan I opened the doc issue MicrosoftDocs/PowerShell-Docs#7233 and assigned it to you. Please update the doc with this new feature when you get a chance. |
🎉 |
PR Summary
PR implements a way to view help on alternate screen buffer for full help and uses a Pager from Microsoft.PowerShell.Pager.
Also it implements dynamic help for parameters by showing it below the current command line like MenuComplete.
Still working on tests.
PR Checklist
Microsoft Reviewers: Open in CodeFlow