microsoft / microsoft/TypeScript

Report errors (and quickfixes) for incorrect JSDoc

Abierto
#15,852 6 comentarios 3 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Domain: JSDoc In Discussion Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

TypeScript Version: nightly (2.4.0-dev.20170515)

Code

/**
 * @param abcdeg A parameter
 */
function f(abcdefg: number) {
    abcdeg;
}

Expected behavior:

Can fix spelling for either abcdeg.

Actual behavior:

Does not work in jsdoc.

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 el procesamiento de TypeScript/JSDoc para el ejemplo de función proporcionado y rastrea cómo se procesan actualmente los nombres y las referencias de @param mal escritos. Determina dónde se generan los diagnósticos y los quickfixes para estas discrepancias. Se considera terminado cuando el ejemplo informa del error ortográfico y ofrece una corrección para cualquiera de las dos apariciones, y se han añadido las pruebas correspondientes para ambos casos.

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

Evaluación

Stack tecnológico
typescript
Área
compilers
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.