Skip to content

Commit 1570143

Browse files
authored
Clear release notes (#102)
2 parents 985ad34 + 69e6af4 commit 1570143

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

RELEASE_NOTES.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Frequenz Microgrid API Client Release Notes
22

3-
## Upgrading
3+
## Summary
44

5-
- `ApiClient`:
5+
<!-- Here goes a general summary of what this release is about -->
66

7-
* The class was renamed to `MicrogridApiClient`.
8-
* The `api` attribute was renamed to `stub`.
9-
* The constructor parameter `channel_options` was renamed to `channels_defaults` to match the name used in `BaseApiClient`.
10-
* The constructor now accepts a `connect` parameter, which is `True` by default. If set to `False`, the client will not connect to the server upon instantiation. You can connect later by calling the `connect()` method.
7+
## Upgrading
118

12-
* The `frequenz-client-base` dependency was bumped to v0.8.0.
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-
- The client now inherits from `frequenz.client.base.BaseApiClient`, so it provides a few new features, like `disconnect()`ing or using it as a context manager. Please refer to the [`BaseApiClient` documentation](https://frequenz-floss.github.io/frequenz-client-base-python/latest/reference/frequenz/client/base/client/#frequenz.client.base.client.BaseApiClient) for more information on these features.
17-
- The client now supports setting reactive power for components through the new `set_reactive_power` method.
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)