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

Make use of both detail and documentation fields #238180

Closed
meganrogge opened this issue Jan 17, 2025 · 6 comments · Fixed by #238391
Closed

Make use of both detail and documentation fields #238180

meganrogge opened this issue Jan 17, 2025 · 6 comments · Fixed by #238391
Assignees
Labels
feature-request Request for new features or functionality insiders-released Patch has been released in VS Code Insiders terminal-suggest verified Verification succeeded
Milestone

Comments

@meganrogge
Copy link
Contributor

When we have a command that has both a description and a path, we should show those both similar to what the editor does.

We'd need to add documentation to our API.

* A human-readable string with additional information
* about this item, like type or symbol information.
*/
detail?: string;
/**
* A human-readable string that represents a doc-comment.
*/
documentation?: string | MarkdownString;

Image

@meganrogge
Copy link
Contributor Author

cc @Tyriar

@meganrogge meganrogge self-assigned this Jan 17, 2025
@meganrogge meganrogge added feature-request Request for new features or functionality terminal-suggest labels Jan 17, 2025
@vs-code-engineering vs-code-engineering bot added unreleased Patch has not yet been released in VS Code Insiders insiders-released Patch has been released in VS Code Insiders and removed unreleased Patch has not yet been released in VS Code Insiders labels Jan 21, 2025
@meganrogge
Copy link
Contributor Author

We do not show simultaneously because they provide the same info, so it would be redundant to do so.

Verify that when you open the suggest widget in the terminal and type code-insiders, for example, you see the command path description. Use ctrl+space to open documentation, which will show the command's description and path.

@meganrogge meganrogge added the verification-needed Verification of issue is requested label Jan 27, 2025
@alexr00
Copy link
Member

alexr00 commented Jan 28, 2025

I set "terminal.integrated.suggest.enabled": true, but I don't get terminal suggestions. Anything else I need to do?

@meganrogge
Copy link
Contributor Author

@alexr00 waiting for this build to finish which fixes terminal suggest https://monacotools.visualstudio.com/Monaco/_build/results?buildId=316161&view=results

@roblourens
Copy link
Member

I got the new build, and I only see files in zsh, no commands

Image

@meganrogge
Copy link
Contributor Author

Image

@karthiknadig karthiknadig added verified Verification succeeded and removed verification-needed Verification of issue is requested labels Jan 28, 2025
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 insiders-released Patch has been released in VS Code Insiders terminal-suggest verified Verification succeeded
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants