Skip to content

Commit 38798ee

Browse files
authored
Clear release notes (#421)
2 parents b5ae33c + 7bed2c2 commit 38798ee

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

RELEASE_NOTES.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# Frequenz channels Release Notes
22

3+
## Summary
4+
5+
<!-- Here goes a general summary of what this release is about -->
6+
7+
## Upgrading
8+
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10+
311
## New Features
412

5-
- An experimental `NopReceiver` implementation has been added, which can be used as a place-holder receiver that never receives a message.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
614

7-
- The experimental `OptionalReceiver` has been deprecated. It will be removed with the next major release. It can be replaced with a `NopReceiver` as follows:
15+
## Bug Fixes
816

9-
```python
10-
opt_recv: Receiver[T] | None
11-
recv: Receiver[T] = NopReceiver[T]() if opt_recv is None else opt_recv
12-
```
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)