Skip to content
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.

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

Show parameter help in the parameter tooltips #5068

Open
2 tasks done
MartinGC94 opened this issue Oct 22, 2024 · 3 comments
Open
2 tasks done

Show parameter help in the parameter tooltips #5068

MartinGC94 opened this issue Oct 22, 2024 · 3 comments
Labels
Area-UI Issue-Enhancement A feature request (enhancement). Needs: Triage Maintainer attention needed!

Comments

@MartinGC94
Copy link
Contributor

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

@MartinGC94 MartinGC94 added Issue-Enhancement A feature request (enhancement). Needs: Triage Maintainer attention needed! labels Oct 22, 2024
@JustinGrote
Copy link
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.

@JustinGrote JustinGrote added Area-UI Needs: Triage Maintainer attention needed! and removed Needs: Triage Maintainer attention needed! labels Oct 23, 2024
@MartinGC94
Copy link
Contributor Author

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
Copy link
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-UI Issue-Enhancement A feature request (enhancement). Needs: Triage Maintainer attention needed!
Projects
None yet
Development

No branches or pull requests

2 participants