Microsoft/TypeScript

`@` character in code block renders poorly in tooltip

Open

#49,273 opened on May 26, 2022

View on GitHub
 (7 comments) (10 reactions) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: JSDocHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

Does this issue occur when all extensions are disabled?: Yes

  • VS Code Version: 1.67.2 (Universal)
  • OS Version: Darwin arm64 21.4.0

Steps to Reproduce:

When having this chunk of source code:

/**
 * Description of CursorClass
 *
 * Example Usage:
 * 
 * ````ts
 * @IsCursor(CursorClass)
 * cursor?: CursorClass | null;
 * ````
 */

VSCode renders as this: image

It should render as this: image

Contributor guide

Research direction
Investigate how the tooltip renders markdown code blocks, particularly when the @ character is present. Look into the markdown parser or syntax highlighter used in the editor.
Tech stack
typescript
Domain
frontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65