Microsoft/TypeScript

Type name in @throws not rendered as a link

Open

#59.578 aberto em 9 de ago. de 2024

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (6.726 forks)batch import
Domain: JSDocHelp WantedPossible Improvement

Métricas do repositório

Stars
 (48.455 stars)
Métricas de merge de PR
 (Mesclagem média 6d 17h) (9 fundiu PRs em 30d)

Description

According to the JSDoc documentation you can put a type name after a @throws. Something like @throws {Error}. I would expect the type name to be rendered as a link, but it is rendered as {Error}

Guia do colaborador

Direção de pesquisa
Investigue como o analisador e renderizador JSDoc do TypeScript lida com tags @throws com nomes de tipo e modifique a lógica de renderização para converter nomes de tipo entre chaves em hiperlinks.
Pilha de tecnologia
typescript
Domain
documentation
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.
Claro
Prerequisites
TypeScriptJSDoc
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70