Microsoft/vscode

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

Open

#201.884 geöffnet am 5. Jan. 2024

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (1 zugewiesene Person)TypeScript (10.221 Forks)batch import
apibughelp wantedwebview

Repository-Metriken

Stars
 (74.848 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 11h 43m) (1.000 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Überprüfe den tatsächlichen viewType Wert eines TabInputWebview und vergleiche ihn mit WebviewPanel.viewType. Entscheide, ob das Präfix in der API entfernt oder die Dokumentation entsprechend aktualisiert werden soll.
Tech Stack
typescript
Domain
api
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
TypeScriptVSCode API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60