diff --git a/docs/sphinx/source/whatsnew/v0.9.6.rst b/docs/sphinx/source/whatsnew/v0.9.6.rst index 06e7049a28..f21fe80ac6 100644 --- a/docs/sphinx/source/whatsnew/v0.9.6.rst +++ b/docs/sphinx/source/whatsnew/v0.9.6.rst @@ -23,7 +23,8 @@ Testing Documentation ~~~~~~~~~~~~~ - +* Updated the description of the interval parameter in + :py:func:`pvlib.iotools.get_psm3`. (:issue:`1702`, :pull:`1712`) Benchmarking ~~~~~~~~~~~~~ @@ -35,4 +36,4 @@ Requirements Contributors ~~~~~~~~~~~~ - +* Adam R. Jensen (:ghuser:`adamrjensen`) diff --git a/pvlib/iotools/psm3.py b/pvlib/iotools/psm3.py index dee4235862..c5da205d74 100644 --- a/pvlib/iotools/psm3.py +++ b/pvlib/iotools/psm3.py @@ -88,8 +88,8 @@ def get_psm3(latitude, longitude, api_key, email, names='tmy', interval=60, PSM3 API parameter specifing year or TMY variant to download, see notes below for options interval : int, {60, 5, 15, 30} - interval size in minutes, must be 5, 15, 30 or 60. Only used for - single-year requests (i.e., it is ignored for tmy/tgy/tdy requests). + interval size in minutes, must be 5, 15, 30 or 60. Must be 60 for + typical year requests (i.e., tmy/tgy/tdy). attributes : list of str, optional meteorological fields to fetch. If not specified, defaults to ``pvlib.iotools.psm3.ATTRIBUTES``. See references [2]_, [3]_, and [4]_