Microsoft/vscode

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

Open

#201 884 ouverte le 5 janv. 2024

Voir sur GitHub
 (1 commentaire) (1 réaction) (1 assigné)TypeScript (10 221 forks)batch import
apibughelp wantedwebview

Métriques du dépôt

Stars
 (74 848 stars)
Métriques de merge PR
 (Merge moyen 11h 43m) (1 000 PRs mergées en 30 j)

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?

Guide contributeur

Direction de recherche
Inspectez la valeur réelle du viewType d'un TabInputWebview et comparez la avec WebviewPanel.viewType. Décidez s'il faut supprimer le préfixe dans l'API ou mettre à jour la documentation en conséquence.
Stack technique
typescript
Domaine
api
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
TypeScriptVSCode API
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60