Skip to content

Commit 67cd9ca

Browse files
committed
Improve RELEASE_NOTES wording and formatting
Mainly format words referring to code as such. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 837d482 commit 67cd9ca

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

RELEASE_NOTES.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,10 @@
1212
battery_power_receiver = microgrid.battery_pool().power.new_receiver()
1313
```
1414

15-
+ Formulas composition has changed (#327) -
16-
- receivers from formulas are no longer composable.
17-
- formula composition is now done by composing FormulaEngine instances.
18-
- Automatic formulas from the logical meter and *pools, are now
19-
properties, and return `FormulaEngine` instances, which can be
20-
composed further, or can provide a receiver to fetch values.
15+
* Formulas composition has changed (#327)
16+
* Receivers from formulas are no longer composable.
17+
* Formula composition is now done by composing FormulaEngine instances.
18+
* Automatic formulas from the logical meter and \*pools, are now properties, and return `FormulaEngine` instances, which can be composed further, or can provide a receiver to fetch values.
2119

2220
``` python
2321
grid_power_receiver = microgrid.logical_meter().grid_power.new_receiver()
@@ -30,15 +28,15 @@
3028
inverter_power_receiver = self._inverter_power.new_receiver()
3129
```
3230

33-
* Update BatteryStatus to mark battery with unknown capacity as not working (#263)
31+
* Update `BatteryStatus` to mark battery with unknown capacity as not working (#263)
3432
* The channels dependency was updated to v0.14.0 (#292)
3533
* Some properties for `PowerDistributingActor` results were renamed to be more consistent between `Success` and `PartialFailure`:
3634
* The `Success.used_batteries` property was renamed to `succeeded_batteries`.
3735
* The `PartialFailure.success_batteries` property was renamed to `succeeded_batteries`.
3836
* The `succeed_power` property was renamed to `succeeded_power` for both `Success` and `PartialFailure`.
39-
* Update MovingWindow to accept size parameter as timedelta instead of int (#269).
37+
* Update `MovingWindow` to accept the `size` parameter as `timedelta` instead of `int` (#269).
4038
This change allows users to define the time span of the moving window more intuitively, representing the duration over which samples will be stored.
41-
* Add a resampler in the MovingWindow to control the granularity of the samples to be stored in the underlying buffer (#269).
39+
* Add a resampler in the `MovingWindow` to control the granularity of the samples to be stored in the underlying buffer (#269).
4240
Notice that the parameter `sampling_period` has been renamed to `input_sampling_period`
4341
to better distinguish it from the sampling period parameter in the resampler.
4442
* The serialization feature for the ringbuffer was made more flexible. The `dump` and `load` methods can now work directly with a ringbuffer instance.
@@ -47,9 +45,11 @@
4745

4846
## New Features
4947

50-
* Automatic creation of core data-pipeline actors, to eliminate a lot
51-
of boiler plate code. This makes it much simpler to deploy apps
52-
(#270). For example:
48+
* The core data-pipeline actors are now created automatically (#270).
49+
50+
This eliminates a lot of boiler plate code and makes it much simpler to deploy apps.
51+
52+
For example:
5353

5454
``` python
5555
async def run():
@@ -59,9 +59,9 @@
5959
grid_power = microgrid.logical_meter().grid_power()
6060
```
6161

62-
* The `Result` class (and subclasses) for the `PowerDistributingActor` are now dataclasses, so logging them will produce a more detailed output.
62+
* The `Result` class (and subclasses) for the `PowerDistributingActor` are now `dataclass`es, so logging them will produce a more detailed output.
6363

6464
## Bug Fixes
6565

66-
* Change PowerDistributor to use all batteries if none is working (#258)
67-
* Update the ordered ring buffer to fix the len() function so that it returns a value equal to or greater than zero, as expected (#274)
66+
* Change `PowerDistributor` to use all batteries when none are working (#258)
67+
* Update the ordered ring buffer to fix the `len()` function so that it returns a value equal to or greater than zero, as expected (#274)

0 commit comments

Comments
 (0)