Skip to content

Commit 9a8b9d8

Browse files
committed
Update release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 7079533 commit 9a8b9d8

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

RELEASE_NOTES.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,28 @@
66

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
9+
- `frequenz.sdk.timseries`:
10+
- The resample classes in the `frequenz.sdk.timseries` were removed. Use the new `frequenz.sdk.timseries.resampling.Resampler` class instead.
11+
- The `ResamplingFunction` was moved to the new module `frequenz.sdk.timseries.resampling`.
12+
13+
- `frequenz.sdk.actor.ComponentMetricsResamplingActor`:
14+
- The constructor now requires to pass all arguments as keywords.
15+
- The following constructor arguments were renamed to make them more clear:
16+
- `subscription_sender` -> `data_sourcing_request_sender`
17+
- `subscription_receiver` -> `resampling_request_receiver`
18+
1019

1120
## New Features
1221

13-
<!-- Here goes the main new features and examples or instructions on how to use them -->
22+
- New in `frequenz.sdk.timeseries`:
23+
24+
- `Source` and `Sink` types to work generically with streaming timeseries.
25+
26+
- New `frequenz.sdk.timeseries.resampling` module with:
27+
- `Resampler` class that works on timseries `Source` and `Sink`.
28+
- `ResamplingFunction` (moved from `frequenz.sdk.timeseries`).
29+
- `ResamplingError` and `SourceStoppedError` exceptions.
30+
- `average` function (the default resampling function).
1431

1532
## Bug Fixes
1633

0 commit comments

Comments
 (0)