angular/components

Missing docs for properties/methods

Open

#8,832 opened on Dec 6, 2017

View on GitHub
 (12 comments) (1 reaction) (1 assignee)TypeScript (6,650 forks)batch import
P3area: manydocshelp wanted

Repository metrics

Stars
 (24,044 stars)
PR merge metrics
 (Avg merge 3d 12h) (98 merged PRs in 30d)

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.

Contributor guide

Research direction
Locate each listed class in the source code and add JSDoc comments for the missing properties and methods. The documentation is auto generated from comments.
Tech stack
typescriptangular
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitAngular
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80