docs(material/dialog): state when notification observables close #21336
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
google-cla
bot
added
the
cla: yes
crisbeto
reviewed
Dec 12, 2020
src/material/dialog/dialog.md
Outdated
| @@ -14,7 +14,7 @@ let dialogRef = dialog.open(UserProfileComponent, { | |||
| ``` | |||
|
|
|||
| The `MatDialogRef` provides a handle on the opened dialog. It can be used to close the dialog and to | |||
| receive notification when the dialog has been closed. | |||
| receive notification when the dialog has been closed. Any notification Observables will close with the dialog. | |||
There was a problem hiding this comment.
Not something you added, but we might as well fix it. The "receive notification" should be "receive notifications".
Also I think the correct terminology is that the observables will be "completed" when the dialog is closed, not that they'll be "closed".
There was a problem hiding this comment.
You're right, the terminology was indeed not correct. I was thinking of Subscriptions instead of Observables.
I fixed both, but had to rephrase slightly.
crisbeto
added
docs
mmalerba
pushed a commit
that referenced
this pull request
Dec 14, 2020
) * docs(material/dialog): state when notification observables close * docs(material/dialog): improve wording (cherry picked from commit 8cd497b)
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's currently not stated if and when the notification observables from
MatDialogRefare closed. This causes questions and discussions both online and offline (in my team at work to be precise).See different answers and comments in:
I think this matter should be mentioned in the documentation.