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

Include information about option values #241970

Open
TylerLeonhardt opened this issue Feb 25, 2025 · 5 comments
Open

Include information about option values #241970

TylerLeonhardt opened this issue Feb 25, 2025 · 5 comments
Assignees
Labels
feature-request Request for new features or functionality terminal-suggest
Milestone

Comments

@TylerLeonhardt
Copy link
Member

Testing #241771

image

I wish I knew the type for these/enum values in the documentation on the right side.

Like for this --omit it has parameter value completions:
image

but I don't know anything about them when I'm looking at the completion item for --omit:
image

@meganrogge
Copy link
Contributor

meganrogge commented Feb 25, 2025

This is sort of related to the idea #241828 that we'd insert a space and trigger suggestions when one is accepted.

@meganrogge
Copy link
Contributor

I guess the question is why do you need to know at that --omit| stage that there are parameters? Can't you just keep typing?

@meganrogge meganrogge added under-discussion Issue is under discussion for relevance, priority, approach terminal-suggest labels Feb 25, 2025
@TylerLeonhardt
Copy link
Member Author

Sometimes flags can be ambiguous without knowing their parameter type. If I don't know the parameter I'm looking for to do a task, it would be better to type/enum info upfront so I can make a better decision.

Just like editor suggest. I'd like to know the parameters of a function and their values:
image

@meganrogge meganrogge added feature-request Request for new features or functionality and removed under-discussion Issue is under discussion for relevance, priority, approach labels Feb 25, 2025
@Tyriar
Copy link
Member

Tyriar commented Feb 26, 2025

This is what fig is capable of showing, we don't have the RHS yet but probably should:

Image

Not sure about enumerating all the options in detail, but adding sub-text like above would help the user scanning what they're after, especially when detail is hidden.

@Tyriar Tyriar added this to the March 2025 milestone Feb 26, 2025
@Tyriar Tyriar changed the title Include information about parameter values Include information about option values Feb 26, 2025
@Tyriar
Copy link
Member

Tyriar commented Mar 4, 2025

Bumped the priority here, I think this will improve the UX of using options quite a bit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for new features or functionality terminal-suggest
Projects
None yet
Development

No branches or pull requests

3 participants