Dynamic help should show .NET API overloads

Open
#2,615 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by tracing the default Alt+h dynamic-help path for a .NET API and compare its current output with the SetEnvironmentVariable example in the issue. Done means dynamic help displays the available overload definitions, including their argument counts and values, while preserving the existing text content.

Written by the indexing model from the issue text.

Description

Issue-Enhancement

Description of the new feature/enhancement

When using the default Alt+h for dynamic help with a .NET API, it should show the overloads to make it easier for the user to determine the number of args and the arg values.

Proposed technical implementation details (optional)

The text content should be the same as what you get today:

PS> [environment]::SetEnvironmentVariable

OverloadDefinitions
-------------------
static void SetEnvironmentVariable(string variable, string value)
static void SetEnvironmentVariable(string variable, string value, System.EnvironmentVariableTarget target)
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.