Clarify firing of import_notification_stream in doc comment
#5811
Conversation
This file contains 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
bkchr
approved these changes
Sep 24, 2024
|
@ffarall could you please add a prdoc. |
lexnv
approved these changes
Sep 24, 2024
michalkucharczyk
approved these changes
Sep 24, 2024
Co-authored-by: Michal Kucharczyk <[email protected]>
|
@bkchr prdoc added. I wasn't sure before if it was needed, given that it's a change in the comments only. But it's there now. |
bkchr
approved these changes
Sep 24, 2024
bkchr
reviewed
Sep 24, 2024
auto-merge was automatically disabled
September 24, 2024 22:37
Head branch was pushed to by a user without write access
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
paritytech-ci
pushed a commit
that referenced
this pull request
Oct 1, 2024
# Description Updates the doc comment on the `import_notification_stream` to make its behaviour clearer. Closes [Unexpected behaviour of block `import_notification_stream`](#5596). ## 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](#5596), and as discussed there, this PR aims to prevent this confusion in future devs looking to make use of this functionality. # Checklist * [x] My PR includes a detailed description as outlined in the "Description" and its two subsections above. * [ ] My PR follows the [labeling requirements]( https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md#Process ) of this project (at minimum one label for `T` required) * External contributors: ask maintainers to put the right label on your PR. * [x] I have made corresponding changes to the documentation (if applicable) * [x] I have added tests that prove my fix is effective or that my feature works (if applicable) You can remove the "Checklist" section once all have been checked. Thank you for your contribution! --------- Co-authored-by: Michal Kucharczyk <[email protected]> Co-authored-by: Bastian Köcher <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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_streamto 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
Trequired)You can remove the "Checklist" section once all have been checked. Thank you for your contribution!