Skip to content

Commit 6fedb02

Browse files
committed
Clear release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent cfede0a commit 6fedb02

File tree

1 file changed

+4
-19
lines changed

1 file changed

+4
-19
lines changed

RELEASE_NOTES.md

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

33
## Summary
44

5-
This release ships many small improvements and bug fixes to `Quantity`s. It also depends on [channels](https://github.com/frequenz-floss/frequenz-channels-python/) v0.16.0, so users must update the dependency too.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9-
- `Channels` has been upgraded to version 0.16.0, for information on how to upgrade please read the [channels v0.16.0 release notes](visit https://github.com/frequenz-floss/frequenz-channels-python/releases/tag/v0.16.0).
10-
- `Quantity` objects are no longer hashable. This is because of the pitfalls of hashing `float` values.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1110

1211
## New Features
1312

14-
- Quantities
15-
16-
* Add support for the unary negative operator (negation of a quantity).
17-
* Add `abs()`.
18-
* Add a `isclose()` method on quantities to compare them to other values of the same type. Because `Quantity` types are just wrappers around `float`s, direct comparison might not always be desirable.
19-
* Add `zero()` constructor (which returns a singleton) to easily get a zero value.
20-
* Add multiplication by `Percentage` types.
21-
* Add a new quantity class `Frequency` for frequency values.
22-
* Add a new quantity class `Temperature` for temperature values.
23-
24-
- `FormulaEngine` arithmetics now supports scalar multiplication with `float`s and addition with `Quantity`s.
25-
- Add a new `temperature` method for streaming average temperature values for the battery pool.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
2614

2715
## Bug Fixes
2816

29-
- Fix formatting issue for `Quantity` objects with zero values.
30-
- Fix formatting issue for `Quantity` when the base value fulfills `math.isinf()` or `math.isnan()`.
31-
- Fix clamping to 100% for the battery pool SoC scaling calculation.
32-
- Fix indexing for empty `MovingWindow`s (now it properly raises an `IndexError`).
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)