Microsoft/vscode

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

Open

#201.884 aperta il 5 gen 2024

Vedi su GitHub
 (1 commento) (1 reazione) (1 assegnatario)TypeScript (10.221 fork)batch import
apibughelp wantedwebview

Metriche repository

Star
 (74.848 star)
Metriche merge PR
 (Merge medio 11h 43m) (1000 PR mergiate in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Esamina il valore effettivo di viewType da un TabInputWebview e confrontalo con WebviewPanel.viewType. Decidi se rimuovere il prefisso nell'API o aggiornare la documentazione di conseguenza.
Tech stack
typescript
Dominio
api
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
TypeScriptVSCode API
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60