Skip to content

Commit 3ea4919

Browse files
authored
Reset release notes (#47)
2 parents 36cd208 + 0d95e64 commit 3ea4919

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

RELEASE_NOTES.md

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

33
## Summary
44

5-
This release contains a few breaking changes that were required to enhance the
6-
API.
5+
<!-- Here goes a general summary of what this release is about -->
76

87
## Upgrading
98

10-
- The `Dispatch` class is now a frozen dataclass, meaning that it is immutable. Modifications can still be done using `replace`: `dispatch = replace(dispatch, start_time=new_start_time)`.
11-
- The `Client.update()` method now requires named parameters.
12-
- `Client.update()` no longer accepts changes to the `type` and `dry_run` fields.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1310

1411
## New Features
1512

16-
- A new module `frequenz.client.dispatch.test` has been added, providing a fake Service and Client as well as a `DispatchGenerator` to generate `Dispatch` instances filled with random data.
17-
- The `DispatchGenerator.generate_dispatch` method now accepts a `microgrid_id` parameter to generate `Dispatch` instances with a specific microgrid ID.
18-
- The `Client.create()` method now returns the newly created `Dispatch` object.
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)