Skip to content

Commit b6dbc6a

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

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

RELEASE_NOTES.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@
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+
- Now component and microgrid IDs are wrapped in new classes: `ComponentId` and `MicrogridId` respectively.
10+
11+
These classes provide type safety and prevent accidental errors by:
12+
13+
- Making it impossible to mix up microgrid and component IDs (equality comparisons between different ID types always return false).
14+
- Preventing accidental math operations on IDs.
15+
- Providing clear string representations for debugging (MID42, CID42).
16+
- Ensuring proper hash behavior in collections.
17+
18+
To migrate you just need to wrap your `int` IDs with the appropriate class: `0` -> `ComponentId(0)` / `MicrogridId(0)`.
1019

1120
## New Features
1221

0 commit comments

Comments
 (0)