microsoft / microsoft/TypeScript

Quick info for parameter redundantly shows @param tag

Open
#26,876 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

TypeScript Version: 3.1.0-dev.20180830

Code

/**
 * @param p
 * Once upon a time there was a parameter named p.
 * P lived in a function called f.
 * Then a big bad wolf came and blew f down.
 */
function f(p: number): void {}

Expected behavior:

Documentation for p is shown only once.

Actual behavior:

Documentation is shown twice -- once as the normal documentation (good), once as documentation for the @param tag which is redundant since we took the documentation from there. This doubles the size of the quick info.

param

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 with the TypeScript 3.1.0-dev.20180830 reproduction: inspect quick info for parameter p when its JSDoc contains an @param tag. Confirm the current output repeats the parameter documentation, then verify that quick info presents the documentation only once without changing other JSDoc behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.