Skip to content

Handle multi-line description for parameter help content #3358

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

Merged
merged 1 commit into from
Jun 27, 2022

Conversation

daxian-dbw
Copy link
Member

@daxian-dbw daxian-dbw commented Jun 25, 2022

PR Summary

Fix #3356

Handle multi-line description for parameter help content.

CompletionPredictor

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Make sure you've added one or more new tests
  • Make sure you've tested these changes in terminals that PowerShell is commonly used in (i.e. conhost.exe, Windows Terminal, Visual Studio Code Integrated Terminal, etc.)
  • User-facing changes
    • Not Applicable
    • OR
    • Documentation needed at PowerShell-Docs
      • Doc Issue filed:
Microsoft Reviewers: Open in CodeFlow

Copy link
Member

@andyleejordan andyleejordan left a comment

Choose a reason for hiding this comment

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

Assuming you checked how this displays on non-Windows (with a different newline expectation) this looks good to me!

@daxian-dbw
Copy link
Member Author

Yes, I tested on Linux and it works as expected. Here is the GIF on Linux:

CompletionPredictor

@daxian-dbw daxian-dbw merged commit 0ac6c07 into PowerShell:master Jun 27, 2022
@daxian-dbw daxian-dbw deleted the clear branch June 27, 2022 18:04
@ghost
Copy link

ghost commented Mar 8, 2023

🎉 v2.3.0-beta0 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.

ShowParameterHelp does not clear multiline parameter help on escape
2 participants