Skip to content

Commit c89d357

Browse files
committed
Group changes in the RELEASE NOTES
Changes to the same class / sub-system are grouped together, so it is easier to know what changed on each particular part one might be interested in. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 587471c commit c89d357

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

RELEASE_NOTES.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,25 @@
3838
* The `PartialFailure.success_batteries` property was renamed to `succeeded_batteries`.
3939
* The `succeed_power` property was renamed to `succeeded_power` for both `Success` and `PartialFailure`.
4040

41-
* Update `MovingWindow` to accept the `size` parameter as `timedelta` instead of `int` (#269).
42-
This change allows users to define the time span of the moving window more intuitively, representing the duration over which samples will be stored.
41+
* The serialization feature for the ringbuffer was made more flexible. The `dump` and `load` methods can now work directly with a ringbuffer instance.
4342

44-
* Add a resampler in the `MovingWindow` to control the granularity of the samples to be stored in the underlying buffer (#269).
45-
Notice that the parameter `sampling_period` has been renamed to `input_sampling_period`
46-
to better distinguish it from the sampling period parameter in the resampler.
43+
* `MovingWindow`
4744

48-
* The serialization feature for the ringbuffer was made more flexible. The `dump` and `load` methods can now work directly with a ringbuffer instance.
45+
* Accept the `size` parameter as `timedelta` instead of `int` (#269).
46+
47+
This change allows users to define the time span of the moving window more intuitively, representing the duration over which samples will be stored.
48+
49+
* The input data will be resampled if a `resampler_config` is passed (#269).
50+
51+
This allows controlling the granularity of the samples to be stored in the underlying buffer.
52+
53+
Note that the parameter `sampling_period` has been renamed to `input_sampling_period` to better distinguish it from the sampling period parameter in the `resampler_config`.
54+
55+
* `Resampler`
4956

50-
* The `ResamplerConfig` now takes the resampling period as a `timedelta`. The configuration was renamed from `resampling_period_s` to `resampling_period` accordingly.
57+
* The `ResamplerConfig` now takes the resampling period as a `timedelta`. The configuration was renamed from `resampling_period_s` to `resampling_period` accordingly.
5158

52-
* The `SourceProperties` of the resampler now uses a `timedelta` for the input sampling period. The attribute was renamed from `sampling_period_s` to `sampling_period` accordingly.
59+
* The `SourceProperties` of the resampler now uses a `timedelta` for the input sampling period. The attribute was renamed from `sampling_period_s` to `sampling_period` accordingly.
5360

5461
## New Features
5562

0 commit comments

Comments
 (0)