Rename OnlyIfPrevious to WithPrevious
#357
Merged
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
github-actions
bot
added
part:docs
…evious one" With the upcoming name change of `OnlyIfPrevious` to `WithPrevious`, it doesn't look like `filter(WithPrevious(lambda prev, new: prev != new))` is so ugly and verbose to justify having `ChangedOnly` as a special case. Specially since the name is a bit confusing, and not clear enough about what it does. The verbose alternative make it more clear that it's comparing to the previous message. This reverts commit 2b9541c. Signed-off-by: Leandro Lucarella <[email protected]>
The new name makes is more clear that this predicate is adding an extra condition to the message filtering based on the previous message. Signed-off-by: Leandro Lucarella <[email protected]>
Make it more clear that `WithPrevious` is a composable predicate, to build new predicates. Signed-off-by: Leandro Lucarella <[email protected]>
Now that `ChangedOnly` was removed it makes more sense to use that as an example instead of a more obscure example using `is` for comparison. Signed-off-by: Leandro Lucarella <[email protected]>
This matches the `filter()` method. Signed-off-by: Leandro Lucarella <[email protected]>
We don't plan to add more predicates for now, so we rename `_predicates.py` to `_with_previous.py` and `test_predicates_only_if_previous.py` to `test_with_previous.py`. Signed-off-by: Leandro Lucarella <[email protected]>
daniel-zullo-frequenz
approved these changes
Dec 4, 2024
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.
The new name makes is more clear that this predicate is adding an extra condition to the message filtering based on the previous message.
Fixes #355.