Skip to content

Commit ba31a55

Browse files
committed
Clear release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 13a3aa1 commit ba31a55

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

RELEASE_NOTES.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
11
# Frequenz Core Library Release Notes
22

3-
## New Features
3+
## Summary
4+
5+
<!-- Here goes a general summary of what this release is about -->
46

5-
- A new `frequenz.core.enum` module was added, providing a drop-in replacement `Enum` that supports deprecating members.
7+
## Upgrading
68

7-
Example:
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10+
11+
## New Features
812

9-
```python
10-
from frequenz.core.enum import Enum, DeprecatedMember
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
1114

12-
class TaskStatus(Enum):
13-
OPEN = 1
14-
IN_PROGRESS = 2
15-
PENDING = DeprecatedMember(1, "PENDING is deprecated, use OPEN instead")
16-
DONE = DeprecatedMember(3, "DONE is deprecated, use FINISHED instead")
17-
FINISHED = 4
15+
## Bug Fixes
1816

19-
status1 = TaskStatus.PENDING # Warns: "PENDING is deprecated, use OPEN instead"
20-
assert status1 is TaskStatus.OPEN
21-
```
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)