microsoft / microsoft/TypeScript
Overloads do not emit JSDoc on non-implementation signatures
Open
Nobody has claimed this yet.
Domain: Comment Emit
Experience Enhancement
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 3.2.0-dev.201xxxxx
Search Terms:
Code
.ts file
/**
* this will lost
*/
function a()
function a() { }
/**
* this will keep
*/
function b() { }
function c()
/**
* this will keep, but i don't think this is good way
*/
function c() { }
Expected behavior:
all will keep
/**
* this will lost
*/
function a() { }
/**
* this will keep
*/
function b() { }
/**
* this will keep, but i don't think this is good way
*/
function c() { }
Actual behavior:
a is lost
output .js file
function a() { }
/**
* this will keep
*/
function b() { }
/**
* this will keep, but i don't think this is good way
*/
function c() { }
and when it at .d.ts
- a will keep
- b will keep too
- but c will lost
Related Issues:
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 with the supplied .ts overload examples or the linked TypeScript Playground, using the reported TypeScript version, and compare the emitted .js and .d.ts output. Done means JSDoc from non-implementation overload signatures is preserved consistently in the relevant output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100