diff --git a/docs/sphinx/source/whatsnew/v0.15.1.rst b/docs/sphinx/source/whatsnew/v0.15.1.rst index 83b13d01f0..5e93232eed 100644 --- a/docs/sphinx/source/whatsnew/v0.15.1.rst +++ b/docs/sphinx/source/whatsnew/v0.15.1.rst @@ -38,6 +38,9 @@ Documentation * Add AI checkbox to PR template, and auto-generate a comment on PRs from first-time contributors regarding AI and contributing guidelines. (:issue:`2617`, :pull:`2624`) +* Fix a broken docstring reference to ``grounddiffuse`` in + :py:func:`pvlib.irradiance.poa_components` + (:issue:`2089`, :pull:`2708`) Testing @@ -66,4 +69,5 @@ Contributors * Cliff Hansen (:ghuser:`cwhanse`) * Anton Driesse (:ghuser:`adriesse`) * Kevin Anderson (:ghuser:`kandersolar`) +* Rohan Saxena (:ghuser:`r0hansaxena`) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index c67c1ca251..bc2448b036 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -490,7 +490,8 @@ def poa_components(aoi, dni, poa_sky_diffuse, poa_ground_diffuse): poa_ground_diffuse : numeric Ground-reflected irradiance in the plane of the modules, - as calculated by an albedo model (eg. :func:`grounddiffuse`). [Wm⁻²] + as calculated by an albedo model (eg., + :py:func:`~pvlib.irradiance.get_ground_diffuse`). [Wm⁻²] Returns -------