docs: add types to public methods and getters/setters #9558
Conversation
rafaelss95
requested review from
amcdnl,
andrewseguin,
crisbeto,
devversion,
jelbourn,
josephperrott,
kara,
mmalerba and
tinayuangao
as code owners
googlebot
added
the
cla: yes
src/lib/chips/chip-list.ts
Outdated
| get role(): string|null { | ||
| return this.empty ? null : 'listbox'; | ||
| } | ||
| get role(): string | null { return this.empty ? null : 'listbox'; } |
There was a problem hiding this comment.
JSdocs for this?
There was a problem hiding this comment.
"The ARIA role applied to the chip list"
rafaelss95
changed the title
There was a problem hiding this comment.
@rafaelss95 you may want to break this up into smaller PRs; by changing so many files, it will likely require repeated rebasing
src/lib/chips/chip-list.ts
Outdated
| get role(): string|null { | ||
| return this.empty ? null : 'listbox'; | ||
| } | ||
| get role(): string | null { return this.empty ? null : 'listbox'; } |
There was a problem hiding this comment.
"The ARIA role applied to the chip list"
|
@jelbourn Since there are only changes in docs, wouldn't it be better if you could review and merge it ASAP to prevent the repeated rebase? Do you guys have a certain day to review this kind of PR? Btw, I've rebased. |
|
The problem is that anything that touches code (including the types) has to go through Google's presubmit process, which means it gets batched in with other PRs. Anything that gets merged earlier in the pipeline would have a potential conflict. |
|
Got it. How do you suggest to break it? What's the criteria? |
|
Up to you, maybe aim for something like 20 files per PR? |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Basically, this PR adds the missing types/docs for leftovers after #7711.
Fixes #8832.
PS: It'd be great to use something like typedef to ensure types for getters and setters are specified.