`ShowCommandHelp` (F1): improve the UX when multiple matching help topics are presented in a list

Open
#3,572 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
cli

Research direction

Start by tracing the ShowCommandHelp (F1) entry point and review related issue #3571. Determine how multiple fuzzy-matching topics are currently presented. Done means a user can select a matching command or topic from the list and have its help displayed immediately.

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

ShowCommandHelp (F1) also accepts "fuzzy" input, i.e. partial names of about_* topics and command names.

When multiple topics match, a static list is presented that the user cannot meaningfully interact with.
That is, there is no way to select the topic of interest in order to have it displayed.

Instead, the user must make a mental note of the specific command / topic name they're interested in, quit the list display, type the the specific command / topic name, and press F1 again.

A simple menu implementation that allows selecting the topic of interest for instant display would significantly improve the user experience.

Related:

  • #3571
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.