Skip to content

Show parameter help in the parameter tooltips #5068

@MartinGC94

Description

@MartinGC94

Prerequisites

  • I have written a descriptive issue title.
    I have searched all issues to ensure it has not already been reported.

Summary

Similar to how the completion tooltip for commands include a summary of the command, it would be nice if the parameters also included the parameter help. So for ls -Path the tooltip would show:

[string[]]
Specifies a path to one or more locations. Wildcards are accepted. The default location is the current directory (`.`).

Proposed Design

No response

Activity

JustinGrote

JustinGrote commented on Oct 23, 2024

@JustinGrote
Collaborator

Related to #3026, when we sort out some of the LSP stuff to keep this from lagging the interface (especially as help can be slow to resolve) or if we can't we can gate it behind a setting and warn that hovers may take longer to resolve.

added
Needs: TriageMaintainer attention needed!
and removed
Needs: TriageMaintainer attention needed!
on Oct 23, 2024
MartinGC94

MartinGC94 commented on Oct 23, 2024

@MartinGC94
ContributorAuthor

I don't think there's a setting for the command help we get when completing command names and I haven't heard anyone complain about that so I'm not sure if a setting for this is really needed, but of course it doesn't hurt to have it.
I hadn't thought about showing the help when hovering over the parameter but that's a good idea as well.

JustinGrote

JustinGrote commented on Oct 23, 2024

@JustinGrote
Collaborator

It's certainly something I want to improve and I'll put it on my to-do list, we just may need to gate it behind a feature flag for some kinds of lookups if it turns out to really slow down the hover/completer

added and removed
Needs: TriageMaintainer attention needed!
on Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Show parameter help in the parameter tooltips · Issue #5068 · PowerShell/vscode-powershell