ShowParameterHelp: Remove the unnecessary "DESC: " prefix from the parameter description

Open Beginner friendly
#3,470 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
csharp
Domain
cli

Research direction

Start at the ShowParameterHelp function and trace how the parameter description is formatted. Invoke ShowParameterHelp with an example such as Get-Item -Path and press Alt+h; done means the description is displayed without the "DESC: " prefix.

Written by the indexing model from the issue text.

Description

Area-CommandHelp Issue-Enhancement
Prerequisites
  • Write a descriptive title.
Description of the new feature/enhancement

When you invoke the ShowParameterHelp function (bound to Alt+h by default), the parameter description that prints is prefixed with DESC: (e.g., type Get-Item -Path and press Alt+h)

This prefix adds no useful information; I suggest removing it.

Proposed technical implementation details (optional)

No response

Dominant language
C#
Stars
4.4k
Forks
341
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PowerShell/PSReadLine

All issues in PowerShell/PSReadLine

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.