Update release notes

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

RELEASE_NOTES.md

@@ -6,26 +6,88 @@ The `Timer` now can be started with a delay.
 
 ## Upgrading
 
-* Internal variable names in the `Anycast` and `Broadcast` implementations are now private.
+* `Anycast`
+
+  - `__init__`: The `maxsize` argument was renamed to `limit` and made keyword-only and a new optional, keyword-only `name` argument was added. If a `name` is not specified, it will be generated from the `id()` of the instance.
+
+    You should instantiate using `Anycast(name=..., limit=...)` (or `Anycast()` if the defaults are enough) instead of `Anycast(...)` or `Anycast(maxsize=...)`.
+
+* `Bidirectional`
+
+  - The `client_id` and `service_id` arguments were merged into an optional, keyword-only `name`. If a `name` is not specified, it will be generated from the `id()` of the instance.
+
+    You should instantiate using `Bidirectional(name=...)` (or `Bidirectional()` if the default name is enough) instead of `Bidirectional(..., ...)` or `Bidirectional(client_id=..., service_id=...)`.
+
+  - `new_receiver`: The `maxsize` argument was renamed to `limit` and made keyword-only; the `name` argument was also made keyword-only. If a `name` is not specified, it will be generated from the `id()` of the instance instead of a random UUID.
+
+    You should instantiate using `Broadcast(name=name, resend_latest=resend_latest)` (or `Broadcast()` if the defaults are enough) instead of `Broadcast(name)` or `Broadcast(name, resend_latest)`.
+
+* `Broadcast`
+
+  - `__init__`: The `name` argument was made optional and keyword-only; `resend_latest` was also made keyword-only. If a `name` is not specified, it will be generated from the `id()` of the instance.
+
+    You should instantiate using `Broadcast(name=name, resend_latest=resend_latest)` (or `Broadcast()` if the defaults are enough) instead of `Broadcast(name)` or `Broadcast(name, resend_latest)`.
+
+* `Event`
+
+  - `__init__`: The `name` argument was made keyword-only. The default was changed to a more readable version of `id(self)`.
+
+    You should instantiate using `Event(name=...)` instead of `Event(...)`.
+
+* All exceptions that took `Any` as the `message` argument now take `str` instead.
+
+  If you were passing a non-`str` value to an exception, you should convert it using `str(value)` before passing it to the exception.
 
 ## New Features
 
-* `Timer()`, `Timer.timeout()`, `Timer.periodic()` and `Timer.reset()` now take an optional `start_delay` option to make the timer start after some delay.
+* `Anycast`
+
+  - The following new read-only properties were added:
+
+    - `name`: The name of the channel.
+    - `limit`: The maximum number of messages that can be sent to the channel.
+    - `is_closed`: Whether the channel is closed.
+
+  - A more useful implementation of `__str__ and `__repr__` were added for the channel and its senders and receivers.
+
+* `Bidirectional`
+
+  - The following new read-only properties were added:
+
+    - `name`: The name of the channel (read-only).
+    - `is_closed`: Whether the channel is closed (read-only).
+
+  - A more useful implementation of `__str__ and `__repr__` were added for the channel and the client and service handles.
+
+* `Broadcast`
+
+  - The following new read-only properties were added:
+
+    - `name`: The name of the channel.
+    - `latest`: The latest message sent to the channel.
+    - `is_closed`: Whether the channel is closed.
+
+  - A more useful implementation of `__str__ and `__repr__` were added for the channel and the client and service handles.
+
+* `FileWatcher`
+
+  - A more useful implementation of `__str__ and `__repr__` were added.
+
+* `Merge`
+
+  - A more useful implementation of `__str__ and `__repr__` were added.
+
+* `MergeNamed`
 
-  This can be useful, for example, if the timer needs to be *aligned* to a particular time. The alternative to this would be to `sleep()` for the time needed to align the timer, but if the `sleep()` call gets delayed because the event loop is busy, then a re-alignment is needed and this could go on for a while. The only way to guarantee a certain alignment (with a reasonable precision) is to delay the timer start.
+  - A more useful implementation of `__str__ and `__repr__` were added.
 
-* `Broadcast.resend_latest` is now a public attribute, allowing it to be changed after the channel is created.
+* `Peekable`
 
-* The arm64 architecture is now officially supported.
+  - A more useful implementation of `__str__ and `__repr__` were added.
 
-* The documentation was improved to:
+* `Receiver`
 
-  - Show signatures with types.
-  - Show the inherited members.
-  - Documentation for pre-releases are now published.
-  - Show the full tag name as the documentation version.
-  - All development branches now have their documentation published (there is no `next` version anymore).
-  - Fix the order of the documentation versions.
+  - `map()`: The returned map object now has a more useful implementation of `__str__ and `__repr__`.
 
 ## Bug Fixes