Skip to content

Commit d8e2295

Browse files
authored
Clear release notes (#81)
2 parents 6c164c4 + 869af55 commit d8e2295

File tree

1 file changed

+5
-25
lines changed

1 file changed

+5
-25
lines changed

RELEASE_NOTES.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,16 @@
22

33
## Summary
44

5-
The main change in this release is the revamp of exception handling in general. New exceptions were created and `send()` now raises an exception too when it fails.
6-
7-
Hopefully they are now used much more uniformly across the whole library.
5+
<!-- Here goes a general summary of what this release is about -->
86

97
## Upgrading
108

11-
* The `Sender.send()` method now `raise`s a `SenderError` instead of returning `False`. The `SenderError` will typically have a `ChannelClosedError` and the underlying reason as a chained exception.
12-
13-
* The `Receiver.ready()` method (and related `receive()` and `__anext__` when used as an async iterator) now `raise`s a `ReceiverError` and in particular a `ReceiverStoppedError` when the receiver has no more messages to receive.
14-
15-
`Receiver.consume()` doesn't raise any exceptions.
16-
17-
Receivers raising `EOFError` now raise `ReceiverInvalidatedError` instead.
18-
19-
* For channels which senders raise an error when the channel is closed or which receivers stop receiving when the channel is closed, the `SenderError` and `ReceiverStoppedError` are chained with a `__cause__` that is a `ChannelClosedError` with the channel that was closed.
20-
21-
* `ChannelClosedError` now requires the argument `channel` (before it was optional).
22-
23-
* Now exceptions are not raised in Receiver.ready() but in Receiver.consume() (receive() or the async iterator `anext`).
9+
<!-- Here goes notes on how to upgrade from previous versions, including if there are any depractions and what they should be replaced with -->
2410

2511
## New Features
2612

27-
* New exceptions were added:
28-
29-
* `Error`: A base exception from which all exceptions from this library inherit.
30-
31-
* `SendError`: Raised for errors when sending messages.
32-
33-
* `ReceiverError`: Raised for errors when receiving messages.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
3414

35-
* `ReceiverClosedError`: Raised when a receiver don't have more messages to receive.
15+
## Bug Fixes
3616

37-
* `ReceiverInvalidatedError`: Raised when a receiver was invalidated (for example it was converted into a `Peekable`).
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)