@throws block looks weird in VS Code preview
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Needs clarification
- Activity status
- Active
- Tech stack
- typescript
- Domain
- documentation
Research direction
Reproduce the @throws example in the VS Code preview and compare it with the rendering described by the TSDoc @throws documentation. Determine whether the behavior belongs to TSDoc or VS Code; done means the responsible project and expected rendering are confirmed and the issue has a tracked resolution.
Written by the indexing model from the issue text.
Description
I'm not sure if this issue should be reported here or in the VS Code repository, but for now, I'll report it here.
When @throws is used, VS Code shows the block just as follows
It looks a kind of broken for me.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 12
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from microsoft/tsdoc
-
TokenReader subrange bounds enforced inconsistently: peekToken/peekPreviousTokenKind/backtrackToMarker ignore embedded windowPossibly taken @sylvesterkaczmarek claimed this 25 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
microsoft/tsdoc#470 · 2 comments · 6 reactions ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
microsoft/tsdoc#450 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
microsoft/tsdoc#442 · 1 reaction ·
Maintainers usually reply within 1 day
Similar issues
-
enhancement good first issue priority: low size: XS
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
streamplace/streamplace#1351 ·
Maintainers usually reply within 2 days
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
databendlabs/databend-docs#3511 ·
-
automated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 65/100