Microsoft/vscode

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

Open

#201.884 aberto em 5 de jan. de 2024

Ver no GitHub
 (1 comment) (1 reaction) (1 assignee)TypeScript (10.221 forks)batch import
apibughelp wantedwebview

Métricas do repositório

Stars
 (74.848 stars)
Métricas de merge de PR
 (Mesclagem média 11h 43m) (1.000 fundiu PRs em 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?

Guia do colaborador

Direção de pesquisa
Inspecione o valor real do viewType de um TabInputWebview e compare com WebviewPanel.viewType. Decida se remover o prefixo na API ou atualizar a documentação conforme necessário.
Pilha de tecnologia
typescript
Domain
api
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
TypeScriptVSCode API
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60