mathworks / mathworks/MATLAB-extension-for-vscode
Support shortcut keys to display function help information
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 435
- Forks
- 40
- PR merge metrics
- No merged PRs in 30d
Description
Is your feature request related to a problem? Please describe.
Currently, the latest extension cannot quickly display function help information like MATLAB Desktop does. For example, pressing the F1 shortcut key can briefly show the function’s syntax, the meaning of parameters, and hyperlinks to detailed information.
Describe the solution you'd like
I expect that this MATLAB extension for VS Code could make querying help as convenient and fast as in MATLAB Desktop, especially supporting this feature in both the editor and the MATLAB command window(integrated terminal in VS Code).
Describe alternatives you've considered
“I have to open a web page separately to search for the usage of a function
Additional context
None
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining how the extension handles editor shortcuts and the MATLAB command window. Determine how a shortcut could obtain and present function syntax, parameter meanings, and links in both contexts; done means help is quickly accessible from each surface without opening a separate web page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- matlab, typescript, vscode
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100