Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs(material/dialog): add missing descriptions #22854

Merged
merged 1 commit into from Jun 2, 2021
Merged

docs(material/dialog): add missing descriptions #22854

merged 1 commit into from Jun 2, 2021

Conversation

devversion
Copy link
Member

Adds descriptions for public properties showing up in the
API docs. Deprecates the dialogRef member of MatDialogClose.
All other content directives do not expose the dialog ref, and users
should just inject the MatDialogRef if needed, instead of accessing
it through a MatDialogClose instance.

DEPRECATED: MatDialogClose#dialogRef class member to become private.

@devversion devversion added the target: patch This PR is targeted for the next patch release label Jun 1, 2021
@devversion devversion requested a review from crisbeto June 1, 2021 14:41
@devversion devversion requested a review from jelbourn as a code owner June 1, 2021 14:41
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jun 1, 2021
crisbeto
crisbeto approved these changes Jun 1, 2021
View reviewed changes
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

@devversion devversion force-pushed the docs/dialog-missing-descriptions branch from a05e8f1 to ca58d05 Compare June 1, 2021 18:29
jelbourn
jelbourn approved these changes Jun 1, 2021
View reviewed changes
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

lgtm

@devversion
docs(material/dialog): add missing descriptions
ce478f9 
Adds descriptions for public properties showing up in the
API docs.

DEPRECATED: `MatDialogClose#dialogRef` class member to become private.
@devversion devversion force-pushed the docs/dialog-missing-descriptions branch from ca58d05 to ce478f9 Compare June 2, 2021 13:51
@devversion devversion added action: merge The PR is ready for merge by the caretaker target: minor This PR is targeted for the next minor release and removed target: patch This PR is targeted for the next patch release labels Jun 2, 2021
@mmalerba mmalerba merged commit 5bd088e into angular:master Jun 2, 2021
@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 Jul 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jelbourn jelbourn jelbourn approved these changes

@crisbeto crisbeto crisbeto approved these changes

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement target: minor This PR is targeted for the next minor release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@devversion @jelbourn @crisbeto @mmalerba