Skip to content

Commit

Permalink
Clear release notes (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
llucax authored Nov 23, 2022
2 parents 61754af + 6f1c3d4 commit 60e61bd
Showing 1 changed file with 5 additions and 49 deletions.
54 changes: 5 additions & 49 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,60 +2,16 @@

## Summary

The project has a new home!
<!-- Here goes a general summary of what this release is about -->

https://frequenz-floss.github.io/frequenz-channels-python/
## Upgrading

For now the documentation is pretty scarce but we will be improving it with
time.

## Upgrading (breaking changes)

* You need to make sure to use [timezone-aware] `datetime` objects when using
the timestamp returned by [`Timer`], Otherwise you will get an exception.

* Channels methods `get_receiver()` and `get_sender()` have been renamed to
`new_receiver()` and `new_sender()` respectively. This is to make it more
clear that new objects are being created.

* The public API surface has been reduced considerably to make it more clear
where to import symbols. You should update your imports. The new symbol
locations are:

* `frequenz.channels.Anycast`
* `frequenz.channels.Broadcast`
* `frequenz.channels.Anycast`
* `frequenz.channels.Bidirectional`
* `frequenz.channels.Broadcast`
* `frequenz.channels.Peekable`
* `frequenz.channels.Receiver`
* `frequenz.channels.Sender`
* `frequenz.channels.util.Merge`
* `frequenz.channels.util.MergeNamed`
* `frequenz.channels.util.FileWatcher`
* `frequenz.channels.util.Select`
* `frequenz.channels.util.Timer`

* The class `BufferedReceiver` was removed because the interface was really
intended for channel implementations. Users are not supposed to enqueue
messages to receiver but just receive from them. If you used it you can
implement it yourself.

* The class `BidirectionalHandle` was moved to `Bidirectional.Handle`.

* The class `EventType` was moved to `FileWatcher.EventType`.
<!-- Here goes notes on how to upgrade from previous versions, including if there are any depractions and what they should be replaced with -->

## New Features

* Python 3.11 is now supported!
<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

* [`Broadcast`] receivers now get cleaned up once they go out of scope.

* [`Timer`] now returns [timezone-aware] `datetime` objects using UTC as
timezone.

[`Broadcast`]: https://frequenz-floss.github.io/frequenz-channels-python/v0.11/reference/frequenz/channels/#frequenz.channels.Broadcast
[`Timer`]: https://frequenz-floss.github.io/frequenz-channels-python/v0.11/reference/frequenz/channels/#frequenz.channels.Timer
[timezone-aware]: https://docs.python.org/3/library/datetime.html#aware-and-naive-objects
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 comments on commit 60e61bd

Please sign in to comment.