Skip to content

Commit 20cfe44

Browse files
authored
Clear release notes (#157)
2 parents 11e4c5e + 5c9526b commit 20cfe44

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

RELEASE_NOTES.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22

33
## Summary
44

5-
This is a small release to allow for easier interoperability between different APIs.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9-
- Some minimum dependency versions are bumped, so you might need to update your dependencies as well.
10-
- The IDs (`MicrogridId`, `ComponentId`, `SensorId`) are now imported from `frequenz-client-common`. Please add it to your dependencies if you haven't already, then you can replace your imports:
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1110

12-
* `from frequenz.client.microgrid import MicrogridId` -> `from frequenz.client.common.microgrid import MicrogridId`
13-
* `from frequenz.client.microgrid import ComponentId` -> `from frequenz.client.common.microgrid.components import ComponentId`
14-
* `from frequenz.client.microgrid import SensorId` -> `from frequenz.client.common.microgrid.sensors import SensorId`
11+
## New Features
12+
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
14+
15+
## Bug Fixes
16+
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)