|
2 | 2 |
|
3 | 3 | ## Summary |
4 | 4 |
|
5 | | -The project has a new home! |
| 5 | +<!-- Here goes a general summary of what this release is about --> |
6 | 6 |
|
7 | | -https://frequenz-floss.github.io/frequenz-channels-python/ |
| 7 | +## Upgrading |
8 | 8 |
|
9 | | -For now the documentation is pretty scarce but we will be improving it with |
10 | | -time. |
11 | | - |
12 | | -## Upgrading (breaking changes) |
13 | | - |
14 | | -* You need to make sure to use [timezone-aware] `datetime` objects when using |
15 | | - the timestamp returned by [`Timer`], Otherwise you will get an exception. |
16 | | - |
17 | | -* Channels methods `get_receiver()` and `get_sender()` have been renamed to |
18 | | - `new_receiver()` and `new_sender()` respectively. This is to make it more |
19 | | - clear that new objects are being created. |
20 | | - |
21 | | -* The public API surface has been reduced considerably to make it more clear |
22 | | - where to import symbols. You should update your imports. The new symbol |
23 | | - locations are: |
24 | | - |
25 | | - * `frequenz.channels.Anycast` |
26 | | - * `frequenz.channels.Broadcast` |
27 | | - * `frequenz.channels.Anycast` |
28 | | - * `frequenz.channels.Bidirectional` |
29 | | - * `frequenz.channels.Broadcast` |
30 | | - * `frequenz.channels.Peekable` |
31 | | - * `frequenz.channels.Receiver` |
32 | | - * `frequenz.channels.Sender` |
33 | | - * `frequenz.channels.util.Merge` |
34 | | - * `frequenz.channels.util.MergeNamed` |
35 | | - * `frequenz.channels.util.FileWatcher` |
36 | | - * `frequenz.channels.util.Select` |
37 | | - * `frequenz.channels.util.Timer` |
38 | | - |
39 | | -* The class `BufferedReceiver` was removed because the interface was really |
40 | | - intended for channel implementations. Users are not supposed to enqueue |
41 | | - messages to receiver but just receive from them. If you used it you can |
42 | | - implement it yourself. |
43 | | - |
44 | | -* The class `BidirectionalHandle` was moved to `Bidirectional.Handle`. |
45 | | - |
46 | | -* The class `EventType` was moved to `FileWatcher.EventType`. |
| 9 | +<!-- Here goes notes on how to upgrade from previous versions, including if there are any depractions and what they should be replaced with --> |
47 | 10 |
|
48 | 11 | ## New Features |
49 | 12 |
|
50 | | -* Python 3.11 is now supported! |
| 13 | +<!-- Here goes the main new features and examples or instructions on how to use them --> |
51 | 14 |
|
52 | 15 | ## Bug Fixes |
53 | 16 |
|
54 | | -* [`Broadcast`] receivers now get cleaned up once they go out of scope. |
55 | | - |
56 | | -* [`Timer`] now returns [timezone-aware] `datetime` objects using UTC as |
57 | | - timezone. |
58 | | - |
59 | | -[`Broadcast`]: https://frequenz-floss.github.io/frequenz-channels-python/v0.11/reference/frequenz/channels/#frequenz.channels.Broadcast |
60 | | -[`Timer`]: https://frequenz-floss.github.io/frequenz-channels-python/v0.11/reference/frequenz/channels/#frequenz.channels.Timer |
61 | | -[timezone-aware]: https://docs.python.org/3/library/datetime.html#aware-and-naive-objects |
| 17 | +<!-- Here goes notable bug fixes that are worth a special mention or explanation --> |
0 commit comments