bug(date-adapter): Misleading JSDoc for createDate returns type
- Langage dominant
- TypeScript
- Étoiles
- 25k
- Forks
- 6.8k
- Merge moyen
- 1 j 8 h
- PR mergées (30 j)
- 91
Description
### 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
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez dans components/src/material/core/datetime/date-adapter.ts, autour de la ligne 110, et examinez le JSDoc de la méthode createDate ainsi que son type de retour déclaré. Vérifiez le comportement documenté pour les entrées invalides par rapport à la description de la méthode et aux implémentations mentionnées dans l’issue. La tâche est terminée lorsque le JSDoc décrit correctement le type de retour et ce qui se passe lorsque l’entrée est invalide.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- angular, typescript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Activité
- Calme
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 78/100