Skip to content

Commit

Permalink
Prepare release notes for 1.0.0-rc.1 (#284)
Browse files Browse the repository at this point in the history
  • Loading branch information
llucax authored Mar 7, 2024
2 parents e522772 + 7ad6391 commit c6c92ac
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

## Summary

<!-- Here goes a general summary of what this release is about -->
This is the first releasse candidate for version 1.0. It includes few new features and a lot of cleanups and API improvements and polishing. Because of this, there are a lot of breaking changes too, but they should be easy to fix, as they ae mostly renames and reorganizations.

We hope this is the final pre-release before the final 1.0 release, and we don't expect to introduce any further breaking changes. Because of this we encourage you to test it and report any issues you find. You can also use a version constraint like `>= 1.0.0-rc.1, < 2.0.0` as the final version should be compatible.

## Upgrading

Expand Down Expand Up @@ -179,6 +181,8 @@

* `ChannelError` is now generic, so when accessing the `channel` attribute, the type of the channel is preserved.

* The generated documentation / website was greatly improved, both in content and looks.

## Bug Fixes

* `Timer`: Fix bug that was causing calls to `reset()` to not reset the timer, if the timer was already being awaited.

0 comments on commit c6c92ac

Please sign in to comment.