microsoft / microsoft/TypeScript

Include parameter information in quickInfo on function arguments

Open
#29,408 7 comments 14 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: JSDoc Domain: LS: Quick Info Experience Enhancement Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

From https://github.com/Microsoft/vscode/issues/57341

TypeScript Version: 3.3.0-dev.201xxxxx

Search Terms:

Code

  • Quick info
  • quickinfo
  • hover

Repo
For the js:

/**
 * @param {number} x Bla
 */
function foo(x) { }

foo(123)

Hover over 123

Current behavior
No quick info returned

Feature Request
Show the parameter name (x) and potentially other information about it when hovering over function arguments like 123

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the JavaScript example in the issue and inspecting the quick info returned when hovering over 123. Trace the quickInfo path for function arguments, then verify that the result includes the parameter name x and relevant parameter information.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
compilers
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.