microsoft / microsoft/TypeScript-TmLanguage

JSDoc grammar highlights @return {@link ...} as type

Abierto
#877 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
TypeScript
Estrellas
471
Forks
149
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

With the following code, TS claims that {@link TreeItem} is incorrect

export interface TreeDataProvider<T> {
/**
 * @return {@link TreeItem} representation of the element
*/
 getTreeItem(element: T): TreeItem;
}

adding a character between return and {@link TreeItem} resolves it.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Reproduce el procesamiento incorrecto con el ejemplo de JSDoc del issue y, a continuación, inspecciona las reglas de la gramática TextMate de TypeScript que cubren las etiquetas @return y {@link ...} inline. Se considera terminado cuando el enlace ya no se trata como un tipo no válido ni se resalta incorrectamente, mientras que los tipos @return normales siguen funcionando.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
tooling
Tipo de issue
Error
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.