microsoft / microsoft/TypeScript
Support @param tag on function type
Open
Nobody has claimed this yet.
Domain: JSDoc
Domain: LS: Quick Info
Domain: LS: Signature Help
In Discussion
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Examples
/**
* @param a A doc
* @param b B doc
*/
type F = (a: number, b: number) => number;
Hover over a or b -- I would expect to see parameter documentation.
It would also be nice to get it at a in const f: F = (a, b) => a + b;.
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
No file, test, or entry point is named. Reproduce the two hover examples from the issue and inspect the existing handling for @param documentation; done means parameter documentation appears when hovering over a function type's parameters and over parameters in a value typed with that function type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100