Skip to content

Commit 5872570

Browse files
committed
Improve Location.timezone documentation
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 56b1884 commit 5872570

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/frequenz/client/microgrid/_metadata.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ class Location:
2424
timezone: ZoneInfo | None = None
2525
"""The timezone of the microgrid.
2626
27-
The timezone will be set to None if the latitude or longitude points
28-
are not set or the timezone cannot be found given the location points.
27+
If not passed during construction (or `None` is passed), and there is a `longitude`
28+
and `latitude`, then the timezone wil be looked up in a database based on the
29+
coordinates. This lookup could fail, in which case the timezone will still be
30+
`None`.
2931
"""
3032

3133
def __post_init__(self) -> None:

0 commit comments

Comments
 (0)