microsoft / microsoft/TypeScript

Quick info for parameter redundantly shows @param tag

Abierto
#26,876 2 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Committed Domain: LS: Quick Info Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

TypeScript Version: 3.1.0-dev.20180830

Code

/**
 * @param p
 * Once upon a time there was a parameter named p.
 * P lived in a function called f.
 * Then a big bad wolf came and blew f down.
 */
function f(p: number): void {}

Expected behavior:

Documentation for p is shown only once.

Actual behavior:

Documentation is shown twice -- once as the normal documentation (good), once as documentation for the @param tag which is redundant since we took the documentation from there. This doubles the size of the quick info.

param

Guía de contribución

Abrir la guía de contribución

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

Comienza con la reproducción de TypeScript 3.1.0-dev.20180830: inspecciona quick info para el parámetro p cuando su JSDoc contiene una etiqueta @param. Confirma que la salida actual repite la documentación del parámetro y, a continuación, verifica que quick info muestre la documentación solo una vez sin cambiar ningún otro comportamiento de JSDoc.

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

Evaluación

Stack tecnológico
typescript
Área
developer-experience
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.