Make Merge public again and rename it to Merger
#243
Merged
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
Signed-off-by: Leandro Lucarella <[email protected]>
`darglint` was replaced by `pydoclint` a while ago, so we don't need this stuff anymore. Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
added
part:docs
The `Merge` receiver was made private to try to hide the implementation details to the user, but it was a bad idea because the `Merge` receiver has more methods than a plain `Receiver`, in particular `stop()`, which users need to use for guaranteed cleanup. This also means now the `merge()` function returns the `Merge` instance instead of an abstract `Receiver`. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Contributor
Author
|
Enabling auto-merge |
Contributor
daniel-zullo-frequenz
left a comment
daniel-zullo-frequenz
left a comment
There was a problem hiding this comment.
I only have a question and LGTM otherwise
Contributor
Author
|
@shsms last opportunity to complain, if @daniel-zullo-frequenz approves I will merge if you didn't complain before 😆 |
daniel-zullo-frequenz
approved these changes
Dec 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
We need to make
Mergepublic again, because theMergereceiver has more methods than a plainReceiver, in particularstop(), which users need to use for guaranteed cleanup.But in this case it is better to introduce a breaking change to make sure users update to using the new
merge()function, so we rename it toMerger. Also using a noun for the name is more in line with the other classes.This also means now the
merge()function returns theMergerinstance instead of an abstractReceiver.Additionally there are a couple of small unrelated cleanups:
darglint-related stuff, it was replaced bypydoclinta while ago.