Add breaking change to whatsnew and fix linting

pvlib · cwhanse · Mar 9, 2025 · Dec 23, 2024 · Dec 23, 2024 · Dec 23, 2024
commit 7cfb170b297b2d87f930f07e2abf6a2a286a95e3
diff --git a/docs/sphinx/source/whatsnew/v0.11.3.rst b/docs/sphinx/source/whatsnew/v0.11.3.rst
@@ -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
@@ -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`)
-* 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`)
+* The pytz attribute of pvlib.location.Location is now read only. Use the tz attribute
+  to record time zone. The pytz attribute is internally updated if the tz attribute
+  is changed.
+* The tz attribute of pvlib.location.Location now returns an IANA string.
+  (:issue:`2340`, :pull:`2341`)
-* 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`)
+* The pytz attribute of pvlib.location.Location is now read only. Use the tz attribute
+  to record time zone. The pytz attribute is internally updated if the tz attribute
+  is changed.
+* The tz attribute of pvlib.location.Location now returns an IANA string.
+  (:issue:`2340`, :pull:`2341`)
 
 Contributors
 ~~~~~~~~~~~~

diff --git a/pvlib/location.py b/pvlib/location.py
@@ -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.