microsoft / microsoft/TypeScript
Inherited methods not merging JSDoc comments
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
Steps to reproduce
class Foo {
/** foo bar */
method(): void {}
}
class Bar extends Foo {
/** @remarks lorem ipsum */
method(): void {}
}
Behavior with typescript@5.9
Hovering over Bar#method gives:
(method) Bar.method(): void
foo bar
@remarks — lorem ipsum
Behavior with tsgo
Hovering over Bar#method gives:
(method) Bar.method(): void
@remarks — lorem ipsum
Note that the foo bar is gone. I believe that blocks like @remarks being merged is a case not handled by microsoft/typescript-go#2111
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza por las reproducciones de TypeScript 5.9 y tsgo incluidas en el issue y, después, lee microsoft/typescript-go#2111 para conocer el comportamiento relacionado de combinación de JSDoc. Compara cómo se gestiona la documentación de los métodos heredados, de modo que la finalización implique que el texto foo bar y el bloque @remarks se combinen de forma coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- go, typescript
- Área
- compilers
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100