Clarify firing of import_notification_stream
in doc comment
#5811
+8
−2
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.
Description
Updates the doc comment on the
import_notification_stream
to make its behaviour clearer.Closes Unexpected behaviour of block
import_notification_stream
.Integration
Doesn't apply.
Review Notes
The old comment docs caused some confusion to myself and some members of my team, on when this notification stream is triggered. This is reflected in the linked issue, and as discussed there, this PR aims to prevent this confusion in future devs looking to make use of this functionality.
Checklist
T
required)You can remove the "Checklist" section once all have been checked. Thank you for your contribution!