Skip to content

Commit edce1c3

Browse files
authored
Clear release notes (#177)
2 parents c025df1 + 342aae4 commit edce1c3

File tree

1 file changed

+6
-21
lines changed

1 file changed

+6
-21
lines changed

RELEASE_NOTES.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,16 @@
22

33
## Summary
44

5-
This release removes the `timezonefinder` dependency to significantly reduce package size by 66M+ and enable ARM platform support.
6-
7-
> [!WARNING]
8-
> This is a **breaking change** shipped in a patch release because this feature has no known users.
5+
<!-- Here goes a general summary of what this release is about -->
96

107
## Upgrading
118

12-
The `Location.timezone` field no longer performs automatic timezone lookup from latitude/longitude coordinates.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1310

14-
```python
15-
# Automatic timezone lookup (no longer works)
16-
location = Location(latitude=52.52, longitude=13.405)
17-
print(location.timezone) # Previously: ZoneInfo('Europe/Berlin'), now None
18-
```
11+
## New Features
1912

20-
If you need timezone lookup from coordinates, install [`timezonefinder`](https://pypi.org/project/timezonefinder/) separately and implement manual lookup:
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
2114

22-
```python
23-
# Install: pip install timezonefinder
24-
from timezonefinder import TimezoneFinder
25-
from zoneinfo import ZoneInfo
26-
from frequenz.client.microgrid import Location
15+
## Bug Fixes
2716

28-
tf = TimezoneFinder()
29-
tz_name = tf.timezone_at(lat=52.52, lng=13.405)
30-
timezone = ZoneInfo(tz_name) if tz_name else None
31-
location = Location(latitude=52.52, longitude=13.405, timezone=timezone)
32-
```
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)