microsoft / microsoft/TypeScript
Changing single-line JSDoc comments to multiline requires unnecessary edits
Open
Nobody has claimed this yet.
Domain: LS: TSServer
In Discussion
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 3.1.3
Search Terms: jsdoc multiline
Code
/** |Foo */
- Press Enter at the |
/**
* Foo |*/
- Press Enter at the |
Expected behavior:
/**
* Foo
*/
Actual behavior:
/**
* Foo
* */
The leading * has to be deleted now.
Empty JSDoc-Comments work:
/**| */
Press Enter at the |
/**
*
*/
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
Reproduce the JSDoc newline behavior described in the issue with TypeScript 3.1.3 and the latest build, using the two single-line examples as entry points. Trace the editor or language-service handling of Enter in JSDoc comments; done means pressing Enter produces the expected multiline form without requiring deletion of the extra leading * .
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
- Mostly clear
- Newbie friendliness
- 45/100