Skip to content

Commit 04de58a

Browse files
authored
Fix release notes and add a summary (#476)
2 parents 24674a0 + face91c commit 04de58a

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

RELEASE_NOTES.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
New `Quantity` types! These types can have units (power, current, voltage, etc.) and are *type- and unit-safe* in the sense that users can't accidentally sum a power with a voltage, or a power in kW with a power in W.
66

77
## Upgrading
88

@@ -26,20 +26,14 @@
2626

2727
- `MicrogridApiClient.set_power` no longer returns a `protobuf.Empty` result, but a `None`. This won't affect you unless you are using the low level APIs of the SDK.
2828

29-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
30-
3129
## New Features
3230

3331
- The logical meter has a new method that returns producer power, that is the sum of all energy producers.
3432

3533
- `Quantity` types (`Power`, `Current`, `Energy`, `Voltage`) for providing type- and unit-safety when dealing with physical quantities.
3634

37-
<!-- Here goes the main new features and examples or instructions on how to use them -->
38-
3935
## Bug Fixes
4036

4137
- Two bugs in the ring buffer which is used by the `MovingWindow` class were fixed:
4238
- `len(buffer)` was not considering potentially existing gaps (areas without elements) in the buffer.
43-
- A off-by-one error in the gap calculation logic was fixed that recorded a
44-
gap when there was none if an element with a future timestamp was added that
45-
would create a gap of exactly 1.
39+
- A off-by-one error in the gap calculation logic was fixed that recorded a gap when there was none if an element with a future timestamp was added that would create a gap of exactly 1.

0 commit comments

Comments
 (0)