Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clear release notes #28

Merged
merged 1 commit into from
Mar 1, 2024
Merged

Clear release notes #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 4 additions & 15 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,16 @@

## Summary

This release does a bit of restructuring and renaming of classes and modules. It also adds some new features and fixes some bugs.
<!-- Here goes a general summary of what this release is about -->

## Upgrading

The project structure was updated to use more consistent and shorter modules and class names.

* `frequenz.client.base.grpc_streaming_helper` was renamed to `frequenz.client.base.streaming`.

- The `GrpcStreamingHelper` class was renamed to `GrpcStreamBroadcaster`.

+ The constructor argument `retry_spec` was renamed to `retry_strategy`.

* `frequenz.client.base.retry_strategy` was renamed to `frequenz.client.base.retry`.

- The `RetryStrategy` class was renamed to `Strategy`.
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

## New Features

* Functions to convert to `datetime` and protobufs `Timestamp` have been added.
* The generated documentation was improved to include information on defaults and generic parameters.
<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

* When copying `RetryStrategy`s, the type now will be correctly set to the original type.
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
Loading