From 5ab12796cf229c323492d667e12e6eda91a1f3fe Mon Sep 17 00:00:00 2001
From: Leandro Lucarella <luca-frequenz@llucax.com>
Date: Wed, 25 Sep 2024 11:39:20 +0200
Subject: [PATCH] Clear release notes

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
---
 RELEASE_NOTES.md | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index 4d761c95..96a0240b 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -1,19 +1,17 @@
 # Frequenz channels Release Notes
 
+## Summary
+
+<!-- Here goes a general summary of what this release is about -->
+
 ## Upgrading
 
-- `FileWatcher`: The file polling mechanism is now forced by default. This provides reliable and consistent file monitoring on network file systems (e.g., CIFS). However, it may have a performance impact on local file systems or when monitoring a large number of files.
-  - To disable file polling, set the `force_polling` parameter to `False`.
-  - The `polling_interval` parameter defines the interval for polling changes. This is relevant only when polling is enabled and defaults to 1 second.
+<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
 
 ## New Features
 
-- `Timer.reset()` now supports setting the interval and will restart the timer with the new interval.
+<!-- Here goes the main new features and examples or instructions on how to use them -->
 
 ## Bug Fixes
 
-- `FileWatcher`:
-  - Fixed `ready()` method to return False when an error occurs. Before this fix, `select()` (and other code using `ready()`) never detected the `FileWatcher` was stopped and the `select()` loop was continuously waking up to inform the receiver was ready.
-  - Reports file events correctly on network file systems like CIFS.
-
-- `Timer.stop()` and `Timer.reset()` now immediately stop the timer if it is running. Before this fix, the timer would continue to run until the next interval.
+<!-- Here goes notable bug fixes that are worth a special mention or explanation -->