Skip to content

Commit 5ab1279

Browse files
committed
Clear release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 13cf174 commit 5ab1279

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

RELEASE_NOTES.md

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

3+
## Summary
4+
5+
<!-- Here goes a general summary of what this release is about -->
6+
37
## Upgrading
48

5-
- `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.
6-
- To disable file polling, set the `force_polling` parameter to `False`.
7-
- The `polling_interval` parameter defines the interval for polling changes. This is relevant only when polling is enabled and defaults to 1 second.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
810

911
## New Features
1012

11-
- `Timer.reset()` now supports setting the interval and will restart the timer with the new interval.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
1214

1315
## Bug Fixes
1416

15-
- `FileWatcher`:
16-
- 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.
17-
- Reports file events correctly on network file systems like CIFS.
18-
19-
- `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.
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)