Skip to content

Commit b7838af

Browse files
authored
Clear release notes (#28)
2 parents 427cbf6 + ff57447 commit b7838af

File tree

1 file changed

+4
-15
lines changed

1 file changed

+4
-15
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,16 @@
22

33
## Summary
44

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

77
## Upgrading
88

9-
The project structure was updated to use more consistent and shorter modules and class names.
10-
11-
* `frequenz.client.base.grpc_streaming_helper` was renamed to `frequenz.client.base.streaming`.
12-
13-
- The `GrpcStreamingHelper` class was renamed to `GrpcStreamBroadcaster`.
14-
15-
+ The constructor argument `retry_spec` was renamed to `retry_strategy`.
16-
17-
* `frequenz.client.base.retry_strategy` was renamed to `frequenz.client.base.retry`.
18-
19-
- The `RetryStrategy` class was renamed to `Strategy`.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
2010

2111
## New Features
2212

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

2615
## Bug Fixes
2716

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

0 commit comments

Comments
 (0)