Reformat the release notes

This makes it a bit more copy-paste friendly when creating the github
release.

Signed-off-by: Tiyash Basu <[email protected]>

Author: tiyash-basu-frequenz

RELEASE_NOTES.md

@@ -8,50 +8,49 @@
 
 - Removed:
 
-    + `microgrid.components.ComponentStatus`, use `microgrid.electrical_components.ElectricalComponentControlMode` instead
-    + `ComponentErrorCode.UNDERVOLTAGE_SHUTDOWN`, use `ElectricalComponentDiagnosticCode.UNDERVOLTAGE` instead
-    + `microgrid.sensors.SensorMetric`, use `metrics.Metric` instead
-    + `microgrid.sensors.SensorMetricSample`, use `metrics.MetricSample` instead
-    + `microgrid.sensors.SensorCategory`, since it was not useful and potentially confusing
-
-        Sensors can report different sensor metrics, and they could belong to several of these categories simultaneously. This defeats the purpose of having singular categories for sensors. Some more useful categorization may be introduced again in the future.
+  - `microgrid.components.ComponentStatus`, use `microgrid.electrical_components.ElectricalComponentControlMode` instead
+  - `ComponentErrorCode.UNDERVOLTAGE_SHUTDOWN`, use `ElectricalComponentDiagnosticCode.UNDERVOLTAGE` instead
+  - `microgrid.sensors.SensorMetric`, use `metrics.Metric` instead
+  - `microgrid.sensors.SensorMetricSample`, use `metrics.MetricSample` instead
+  - `microgrid.sensors.SensorCategory`, since it was not useful and potentially confusing.
+    Sensors can report different sensor metrics, and they could belong to several of these categories simultaneously. This defeats the purpose of having singular categories for sensors. Some more useful categorization may be introduced again in the future.
 
 - Renamed several symbols to increase consistency and clarity:
 
-    + `microgrid.components`:
+  - `microgrid.components`:
 
-        * The whole package and all proto files, messages, field, enums were renamed to `electrical_components`
-        * `ComponentCategoryMetadataVariant` to `ElectricalComponentCategorySpecificInfo`
-        * `Component.category_type` to `ElectricalComponent.category_specific_info`
-        * `ComponentCategoryMetadataVariant.metadata` to `ElectricalComponentCategorySpecificInfo.kind`
-        * `ComponentErrorCode` to `ElectricalComponentDiagnosticCode`
-        * `ComponentState` to `ElectricalComponentStateSnapshot`
-        * `ComponentState.sampled_at` to `ElectricalComponentStateSnapshot.origin_time`
-        * `ComponentData` to `ElectricalComponentTelemetry` (to better specify its purpose of encapsulating general telemetry data from electrical components)
-        * Grid-related terms to clarify their meaning and purpose:
+    - The whole package and all proto files, messages, field, enums were renamed to `electrical_components`
+    - `ComponentCategoryMetadataVariant` to `ElectricalComponentCategorySpecificInfo`
+    - `Component.category_type` to `ElectricalComponent.category_specific_info`
+    - `ComponentCategoryMetadataVariant.metadata` to `ElectricalComponentCategorySpecificInfo.kind`
+    - `ComponentErrorCode` to `ElectricalComponentDiagnosticCode`
+    - `ComponentState` to `ElectricalComponentStateSnapshot`
+    - `ComponentState.sampled_at` to `ElectricalComponentStateSnapshot.origin_time`
+    - `ComponentData` to `ElectricalComponentTelemetry` (to better specify its purpose of encapsulating general telemetry data from electrical components)
+    - Grid-related terms to clarify their meaning and purpose:
 
-            + `COMPONENT_CATEGORY_GRID` to `ELECTRICAL_COMPONENT_CATEGORY_GRID_CONNECTION_POINT`
-            + `ComponentCategoryMetadataVariant.metadata.grid` to `ElectricalComponentCategorySpecificInfo.kind.grid_connection_point`
+      - `COMPONENT_CATEGORY_GRID` to `ELECTRICAL_COMPONENT_CATEGORY_GRID_CONNECTION_POINT`
+      - `ComponentCategoryMetadataVariant.metadata.grid` to `ElectricalComponentCategorySpecificInfo.kind.grid_connection_point`
 
-    + `microgrid.sensors`:
+  - `microgrid.sensors`:
 
-        * `SensorErrorCode` to `SensorDiagnosticCode`
-        * `SensorData` to `SensorTelemetry` (to better specify its purpose of encapsulating general telemetry data from sensors)
-        * `SensorState` to `SensorStateSnapshot`
-        * `SensorState.sampled_at` to `SensorStateSnapshot.origin_time`
-        * `SensorStateCode.SENSOR_STATE_CODE_ON` to `SensorStateCode.SENSOR_STATE_CODE_OK` (to better indicate that we do not control on/off state of sensors)
+    - `SensorErrorCode` to `SensorDiagnosticCode`
+    - `SensorData` to `SensorTelemetry` (to better specify its purpose of encapsulating general telemetry data from sensors)
+    - `SensorState` to `SensorStateSnapshot`
+    - `SensorState.sampled_at` to `SensorStateSnapshot.origin_time`
+    - `SensorStateCode.SENSOR_STATE_CODE_ON` to `SensorStateCode.SENSOR_STATE_CODE_OK` (to better indicate that we do not control on/off state of sensors)
 
-    + `metrics`:
+  - `metrics`:
 
-        * The file `metric_sample.proto` to `metrics.proto`
-        * `MetricSample.source` to `MetricSample.connection`
-        * `MetricSample.sampled_at` to `sample_time`
+    - The file `metric_sample.proto` to `metrics.proto`
+    - `MetricSample.source` to `MetricSample.connection`
+    - `MetricSample.sampled_at` to `sample_time`
 
 - Renumbered some enum values to remove unnecessary gaps:
 
-    + `microgrid.components.ComponentCategory` (`microgrid.electrical_components.ElectricalComponentCategory`)
-    + `microgrid.components.ComponentErrorCode` (`microgrid.electrical_components.ElectricalComponentDiagnosticCode`)
-    + `metrics.Metric`
+  - `microgrid.components.ComponentCategory` (`microgrid.electrical_components.ElectricalComponentCategory`)
+  - `microgrid.components.ComponentErrorCode` (`microgrid.electrical_components.ElectricalComponentDiagnosticCode`)
+  - `metrics.Metric`
 
 - The minimum allowed version of `protobuf` and `grpcio` has been updated to 6.31.1 and 1.72.1 respectively, you might also need to bump your dependencies accordingly.
 
@@ -61,30 +60,30 @@ Added many new messages and enum values:
 
 - `microgrid.communication_components`: Package with message definitions for communication components
 
-    + `CommunicationComponentDiagnostic`: Message to represent warnings and errors in microgrid communication components
-    + `CommunicationComponentStateSnapshot`: Message to represent the state of communication components
+  - `CommunicationComponentDiagnostic`: Message to represent warnings and errors in microgrid communication components
+  - `CommunicationComponentStateSnapshot`: Message to represent the state of communication components
 
 - `microgrid.electrical_components` (previously `microgrid.components`)
 
-    + `ElectricalComponentDiagnostic`: Message to represent warnings and errors in microgrid electrical components
-    + `ElectricalComponentDiagnosticCode` (previously `ComponentErrorCode`): New diagnostic codes to cover more cases, especially for inverters
-    + `InverterType.INVERTER_TYPE_WIND_TURBINE`: Enum value to represent wind turbine inverters
+  - `ElectricalComponentDiagnostic`: Message to represent warnings and errors in microgrid electrical components
+  - `ElectricalComponentDiagnosticCode` (previously `ComponentErrorCode`): New diagnostic codes to cover more cases, especially for inverters
+  - `InverterType.INVERTER_TYPE_WIND_TURBINE`: Enum value to represent wind turbine inverters
 
 - `microgrid.sensors`
 
-    + Message linking microgrid and sensor IDs
-    + `SensorDiagnostic`: Message to represent warnings and errors in microgrid sensors
-    + Added warnings to sensor `SensorState`
+  - Message linking microgrid and sensor IDs
+  - `SensorDiagnostic`: Message to represent warnings and errors in microgrid sensors
+  - Added warnings to sensor `SensorState`
 
 - `streaming`: Package with message definitions for streaming events
 
-    + `Event`: Enum to represent different types of streaming events (Created, Deleted, Updated)
+  - `Event`: Enum to represent different types of streaming events (Created, Deleted, Updated)
 
 - `types`
 
-    + `TimeIntervalFilter`: Message to standardize time interval filtering across APIs
+  - `TimeIntervalFilter`: Message to standardize time interval filtering across APIs
 
-        This uses `start_time` (inclusive) and `end_time` (exclusive) fields, aligning with ISO 8601 and common programming conventions.
+    This uses `start_time` (inclusive) and `end_time` (exclusive) fields, aligning with ISO 8601 and common programming conventions.
 
 ## Bug Fixes