Skip to content

Commit

Permalink
Update release notes
Browse files Browse the repository at this point in the history
Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
  • Loading branch information
llucax committed Nov 16, 2023
1 parent a64ca09 commit 0858233
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,6 @@

* The following symbols were moved to the top-level `frequenz.channels` package:

- `Merge`
- `MergeNamed`
- `Selected`
- `SelectError`
- `SelectErrorGroup`
Expand All @@ -68,6 +66,14 @@

This channel was removed as it is not recommended practice and was a niche use case. If you need to use it, you can set up two channels or copy the `Bidirectional` class from the previous version to your project.

* `Merge`

Replaced by the new `merge()` function. When replacing `Merge` with `merge()` please keep in mind that this new function will raise a `ValueError` if no receivers are passed to it.

* `MergeNamed`

This class was redundant, use either the new `merge()` function or `select()` instead.

* `Peekable`

This class was removed because it was merely a shortcut to a receiver that caches the last value received. It did not fit the channel abstraction well and was infrequently used.
Expand All @@ -92,6 +98,8 @@

## New Features

* A new `merge()` function was added to replace `Merge`.

* `Anycast`

- The following new read-only properties were added:
Expand Down Expand Up @@ -126,14 +134,6 @@

- A more useful implementation of `__str__ and `__repr__` were added.

* `Merge`

- A more useful implementation of `__str__ and `__repr__` were added.

* `MergeNamed`

- A more useful implementation of `__str__ and `__repr__` were added.

* `Peekable`

- A more useful implementation of `__str__ and `__repr__` were added.
Expand Down

0 comments on commit 0858233

Please sign in to comment.