Skip to content

Commit

Permalink
Add breaking change to whatsnew and fix linting
Browse files Browse the repository at this point in the history
  • Loading branch information
markcampanelli committed Jan 28, 2025
1 parent f691bb6 commit 7cfb170
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
16 changes: 11 additions & 5 deletions docs/sphinx/source/whatsnew/v0.11.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,8 @@ Enhancements

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


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

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

Contributors
~~~~~~~~~~~~
Expand Down
3 changes: 2 additions & 1 deletion pvlib/location.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ class Location:
* ``tz`` is an IANA time-zone string.
* ``pytz`` is a pytz-based time-zone object (read only).
The read-only ``pytz`` attribute will stay in sync with any changes made using ``tz``.
The read-only ``pytz`` attribute will stay in sync with any changes made
using ``tz``.
Location objects support the print method.
Expand Down

0 comments on commit 7cfb170

Please sign in to comment.