Skip to content

Commit 7cfb170

Browse files
Add breaking change to whatsnew and fix linting
1 parent f691bb6 commit 7cfb170

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

docs/sphinx/source/whatsnew/v0.11.3.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@ Enhancements
1414

1515
Bug Fixes
1616
~~~~~~~~~
17-
* Ensure proper tz and pytz types in pvlib.location.Location. tz becomes the
18-
single source of time-zone truth, is the single time-zone setter interface,
19-
and the getter consistently returns an IANA string. datetime.tzinfo
20-
subclasses are fully supported in tz setter. pytz attribute becomes read
21-
only. (:issue:`2340`, :pull:`2341`)
17+
* Ensure proper tz and pytz types in pvlib.location.Location.
18+
(:issue:`2340`, :pull:`2341`)
2219

2320

2421
Documentation
@@ -43,6 +40,15 @@ Maintenance
4340
* asv 0.4.2 upgraded to asv 0.6.4 to fix CI failure due to pinned older conda.
4441
(:pull:`2352`)
4542

43+
Breaking Changes
44+
~~~~~~~~~~~~~~~~
45+
* To ensure that the time zone in pvlib.location.Location remains internally
46+
consistent if/when the time zone is updated, the tz attribute becomes the
47+
single source of time-zone truth, is the single time-zone setter interface,
48+
and its getter consistently returns an IANA string. datetime.tzinfo
49+
subclasses (including time zones from pytz and zoneinfo) are still fully
50+
supported in the tz setter, but the pytz attribute becomes read only.
51+
(:issue:`2340`, :pull:`2341`)
4652

4753
Contributors
4854
~~~~~~~~~~~~

pvlib/location.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ class Location:
2727
* ``tz`` is an IANA time-zone string.
2828
* ``pytz`` is a pytz-based time-zone object (read only).
2929
30-
The read-only ``pytz`` attribute will stay in sync with any changes made using ``tz``.
30+
The read-only ``pytz`` attribute will stay in sync with any changes made
31+
using ``tz``.
3132
3233
Location objects support the print method.
3334

0 commit comments

Comments
 (0)