Skip to content

Conversation

adityapatwardhan
Copy link
Member

@adityapatwardhan adityapatwardhan commented Aug 28, 2020

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

@adityapatwardhan adityapatwardhan changed the title Implement dynamic help for full help and parameter help WIP: Implement dynamic help for full help and parameter help Aug 28, 2020
@ThomasNieto
Copy link

Can you please add some screnshots of the before and after so we can see the difference?

@daxian-dbw
Copy link
Member

@adityapatwardhan Please move the dynamic help related code to a new file, you can name the file DynamicHelp.cs

@adityapatwardhan
Copy link
Member Author

@daxian-dbw All feedback is addressed, please re-review.

@adityapatwardhan
Copy link
Member Author

@ThomasNieto Added screenshots

Copy link
Member

@daxian-dbw daxian-dbw left a 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?

@ghost ghost removed the Needs-Author Feedback label Nov 28, 2020
@adityapatwardhan
Copy link
Member Author

@daxian-dbw - Refactored and added tests as discussed.
Also update version of Microsoft.PowerShell.SDK and System.Management.Automation for 7.1.0 from 7.1.0-rc.2. Please re-review.

@adityapatwardhan adityapatwardhan changed the title WIP: Implement dynamic help for full help and parameter help Implement dynamic help for full help and parameter help Dec 7, 2020
Copy link
Member

@daxian-dbw daxian-dbw left a 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.

@ghost ghost added the Needs-Author Feedback label Dec 8, 2020
@ghost ghost removed the Needs-Author Feedback label Dec 8, 2020
@ghost ghost added the Needs-Author Feedback label Dec 9, 2020
@ghost ghost removed the Needs-Author Feedback label Dec 9, 2020
}

/// <summary>
/// Looks up a localized string similar to Displaying help content is not supported on this console.
Copy link
Member

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.

@ghost
Copy link

ghost commented Jan 21, 2021

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.

@ghost ghost closed this Jan 29, 2021
@daxian-dbw daxian-dbw reopened this Feb 1, 2021
Copy link
Member

@daxian-dbw daxian-dbw left a 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

@ghost ghost removed the Needs-Author Feedback label Feb 10, 2021
@daxian-dbw
Copy link
Member

@adityapatwardhan There are 2 more unresolved comments from the previous review. Please take a look and address them, thanks.

Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@daxian-dbw
Copy link
Member

@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.

@adityapatwardhan adityapatwardhan deleted the dynhelp branch February 12, 2021 17:14
@ghost
Copy link

ghost commented Feb 23, 2021

🎉 v2.2.0-beta2 has been released which incorporates this pull request. 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants