Microsoft/vscode

TabInputWebview viewType comment is inaccurate/unclear or there is a bug in viewType

Open

#201,884 opened on Jan 5, 2024

View on GitHub
 (1 comment) (1 reaction) (1 assignee)TypeScript (10,221 forks)batch import
apibughelp wantedwebview

Repository metrics

Stars
 (74,848 stars)
PR merge metrics
 (Avg merge 11h 43m) (1,000 merged PRs in 30d)

Description

TabInputWebview.viewType in vscode.d.ts is described as:

The type of webview. Maps to {@linkcode WebviewPanel.viewType WebviewPanel's viewType}

WebviewPanel.viewType in vscode.d.ts says:

Identifies the type of the webview panel, such as 'markdown.preview'.

However, when checking a TabInputWebview that I have, the viewType is for the form mainThreadWebview-markdown.preview.

Should the mainThreadWebview- prefix either be stripped from here, or a node added to the docstring in vscode.d.ts making sure that users know to expect it?

Contributor guide

Research direction
Inspect the actual viewType value from a TabInputWebview and compare with WebviewPanel.viewType. Decide whether to strip the prefix in the API or update the documentation accordingly.
Tech stack
typescript
Domain
api
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Mostly clear
Prerequisites
TypeScriptVSCode API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60