Skip to content

Commit cdf3a7b

Browse files
r0hansaxenacwhanse
andauthored
Fix poa components docstring (#2708)
* Fix inexistent function reference in poa_components docstring * Add whatsnew entry for #2089 * Update pvlib/irradiance.py Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Update pvlib/irradiance.py Co-authored-by: Cliff Hansen <cwhanse@sandia.gov> * Fix docstring reference and update contributors list Updated issue references and added contributor. --------- Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
1 parent dce21b5 commit cdf3a7b

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ Documentation
3838
* Add AI checkbox to PR template, and auto-generate a comment on PRs
3939
from first-time contributors regarding AI and contributing guidelines.
4040
(:issue:`2617`, :pull:`2624`)
41+
* Fix a broken docstring reference to ``grounddiffuse`` in
42+
:py:func:`pvlib.irradiance.poa_components`
43+
(:issue:`2089`, :pull:`2708`)
4144

4245

4346
Testing
@@ -66,4 +69,5 @@ Contributors
6669
* Cliff Hansen (:ghuser:`cwhanse`)
6770
* Anton Driesse (:ghuser:`adriesse`)
6871
* Kevin Anderson (:ghuser:`kandersolar`)
72+
* Rohan Saxena (:ghuser:`r0hansaxena`)
6973

pvlib/irradiance.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,8 @@ def poa_components(aoi, dni, poa_sky_diffuse, poa_ground_diffuse):
490490
491491
poa_ground_diffuse : numeric
492492
Ground-reflected irradiance in the plane of the modules,
493-
as calculated by an albedo model (eg. :func:`grounddiffuse`). [Wm⁻²]
493+
as calculated by an albedo model (eg.,
494+
:py:func:`~pvlib.irradiance.get_ground_diffuse`). [Wm⁻²]
494495
495496
Returns
496497
-------

0 commit comments

Comments
 (0)