bug(date-adapter): Misleading JSDoc for createDate returns type
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 78/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Stack tecnológico
- angular, typescript
- Área
- documentation
Línea de trabajo
Comienza en components/src/material/core/datetime/date-adapter.ts alrededor de la línea 110 e inspecciona el JSDoc del método createDate junto con su tipo de retorno declarado. Confirma el comportamiento documentado para entradas no válidas comparándolo con la descripción del método y las implementaciones mencionadas en el issue. La tarea está completada cuando el JSDoc describe correctamente el tipo de retorno y qué ocurre cuando la entrada no es válida.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Is this a regression?
- Yes, this behavior used to work in the previous version
The previous version in which this bug was not present was
No response
Description
(I don't know if it sould be a bug or docs-bug, because it's about JSDoc that not available in the material doc
website, so I couldn't join a link to the doc and create a docs-bug issue).
In the JSDoc of the DateAdapter createDate method, the returns tag indicates that :
@returns The new date, or null if invalid.
But the method returns type is just D, not D | null so it can't be null.
And in the different implementations of the date adapter, when the params are invalid, an error is throws, not a null return.
Reproduction
This bug is more a docs-bug, but date-adapter JSDoc is not directly available from the doc website, so I couldn't join a link to create a docs-bug.
The components/src/material/core/datetime/date-adapter.ts, line 110
Expected Behavior
the returns tag indicates that an error is throws when invalid
Actual Behavior
the returns tag indicates that null is returned when invalid
Environment
no specific env
- Lenguaje dominante
- TypeScript
- Estrellas
- 25k
- Forks
- 6.8k
- Merge medio
- 1 d 13 h
- PR fusionados (30 d)
- 100
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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.
Más de angular/components
-
area: material/datepicker P4
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
angular/components#33763 · 2 comentarios · 3 reacciones ·
Los mantenedores suelen responder en 1 día
-
area: material/table P4
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
angular/components#33709 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
area: material/table docs gemini-triaged P4
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
angular/components#33455 ·
Los mantenedores suelen responder en 1 día
-
area: material/dialog P2
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
angular/components#30536 · 3 reacciones ·
Los mantenedores suelen responder en 1 día
-
docs P4
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
angular/components#28501 · 2 comentarios · 4 reacciones ·
Los mantenedores suelen responder en 1 día
Todos los issues de angular/components
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
siyuan-note/siyuan#20040 ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
RunestoneInteractive/rs#1574 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
remotion-dev/remotion#11901 ·
Los mantenedores suelen responder en 1 día
-
Poll constructor throws for an uncached channel while resolving a message context-menu interactionAbiertobug need repro packages:discord.js
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
discordjs/discord.js#11645 ·
Los mantenedores suelen responder en 3 días
-
🐞 bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Sitecore/content-sdk#641 ·
Los mantenedores suelen responder en 2 días