angular/components

Missing docs for properties/methods

Open

#8 832 ouverte le 6 déc. 2017

Voir sur GitHub
 (12 commentaires) (1 réaction) (1 assigné)TypeScript (6 650 forks)batch import
P3area: manydocshelp wanted

Métriques du dépôt

Stars
 (24 044 stars)
Métriques de merge PR
 (Merge moyen 3j 12h) (98 PRs mergées en 30 j)

Description

Bug, feature request, or proposal:

Bug/Proposal.

What is the expected behavior?

The listed propeties/methods have no docs.

What is the current behavior?

Here's the list that I found of all missing docs.

Class Properties Methods
MatAutocompleteTrigger autocomplete, panelOpen
MatChip ariaSelected
MatChipInput focused focus
MatChipList controlType , ngControl, role onContainerClick, setDescribedByIds
MatDialogClose dialogRef
MatDialogRef id
MatDialogTitle id
MatDatepickerInput registerOnValidatorChange, validate
MatExpansionPanelHeader panel
MatError id
MatInput empty, ngControl, shouldLabelFloat focus, onContainerClick, setDescribedByIds
MatListOption selectionList
MatSelect ngControl, shouldLabelFloat
MatSlideToggleChange All MatSlideToggleChange properties
SimpleSnackBar snackBarRef

Is there anything else we should know?

Related to #8789.

Guide contributeur

Direction de recherche
Localisez chaque classe listée dans le code source et ajoutez des commentaires JSDoc pour les propriétés et méthodes manquantes. La documentation est générée automatiquement à partir des commentaires.
Stack technique
typescriptangular
Domaine
frontend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitAngular
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80