Skip to content

docs(select): Change select's openedChange output comment #9934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 20, 2018
Merged

docs(select): Change select's openedChange output comment #9934

merged 2 commits into from
Feb 20, 2018

Conversation

julianobrasil
Copy link
Contributor

Currently, the docs says the openedChange emits when the panel has been opened. It also emits when it has been closed though.

Related to #9928, specifically #9928 (comment).

@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Feb 13, 2018
@@ -420,7 +420,7 @@ export class MatSelect extends _MatSelectMixinBase implements AfterContentInit,
.pipe(take(1), switchMap(() => this.optionSelectionChanges));
});

/** Event emitted when the select has been opened. */
/** Event emitted when the select has been opened (true) or closed (false). */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the true/false is implied from the boolean typing. Something like "Event emitter when the select panel has been toggled" is clearer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I'll change it, but... I tried to make it clear that true is attached to the opening action and false is attached to the closing action.

Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but can you change the title to docs:...? Otherwise it'll show up as a bugfix in the changelog.

@julianobrasil julianobrasil changed the title fix(docs) Change select's openedChange output comment docs(select) Change select's openedChange output comment Feb 13, 2018
@crisbeto crisbeto added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Feb 13, 2018
@julianobrasil julianobrasil changed the title docs(select) Change select's openedChange output comment docs(select): Change select's openedChange output comment Feb 13, 2018
@jelbourn jelbourn merged commit 8ff51ae into angular:master Feb 20, 2018
@julianobrasil julianobrasil deleted the fixSelectDocs branch March 30, 2018 11:07
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants