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.

Sign up for GitHub

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
Merged

Handle multi-line description for parameter help content #3358

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions PSReadLine/DynamicHelp.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,28 +202,40 @@ private void WriteParameterHelp(dynamic helpContent)
{
helpBlock = new Collection<string>()
{
String.Empty,
string.Empty,
PSReadLineResources.NeedsUpdateHelp
};
}
else
{
string syntax = $"-{helpContent.name} <{helpContent.type.name}>";
string desc = "DESC: " + helpContent.Description[0].Text;

// trim new line characters as some help content has it at the end of the first list on the description.
desc = desc.Trim('\r', '\n');

string details = $"Required: {helpContent.required}, Position: {helpContent.position}, Default Value: {helpContent.defaultValue}, Pipeline Input: {helpContent.pipelineInput}, WildCard: {helpContent.globbing}";

helpBlock = new Collection<string>
{
string.Empty,
syntax,
string.Empty,
desc,
details
string.Empty
};

string text = helpContent.Description[0].Text;
if (text.Contains("\n"))
{
string[] lines = text.Split(new char[] { '\n' }, StringSplitOptions.RemoveEmptyEntries);
for (int i = 0; i < lines.Length; i++)
{
string prefix = i == 0 ? "DESC: " : " ";
string s = prefix + lines[i].Trim('\r');
helpBlock.Add(s);
}
}
else
{
string desc = "DESC: " + text;
// trim new line characters as some help content has it at the end of the first list on the description.
helpBlock.Add(desc.Trim('\r', '\n'));
}

string details = $"Required: {helpContent.required}, Position: {helpContent.position}, Default Value: {helpContent.defaultValue}, Pipeline Input: {helpContent.pipelineInput}, WildCard: {helpContent.globbing}";
helpBlock.Add(details);
}

WriteDynamicHelpBlock(helpBlock);
Expand Down