Skip to content

Commit 699f591

Browse files
authored
Correct return description of PVSystem.get_irradiance and Array.get_irradiance (#1255)
1 parent 8fe6a43 commit 699f591

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

pvlib/pvsystem.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,8 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
374374
Returns
375375
-------
376376
poa_irradiance : DataFrame or tuple of DataFrame
377-
Column names are: ``total, beam, sky, ground``.
377+
Column names are: ``'poa_global', 'poa_direct', 'poa_diffuse',
378+
'poa_sky_diffuse', 'poa_ground_diffuse'``.
378379
"""
379380
dni = self._validate_per_array(dni, system_wide=True)
380381
ghi = self._validate_per_array(ghi, system_wide=True)
@@ -1464,7 +1465,8 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
14641465
Returns
14651466
-------
14661467
poa_irradiance : DataFrame
1467-
Column names are: ``total, beam, sky, ground``.
1468+
Column names are: ``'poa_global', 'poa_direct', 'poa_diffuse',
1469+
'poa_sky_diffuse', 'poa_ground_diffuse'``.
14681470
"""
14691471
# not needed for all models, but this is easier
14701472
if dni_extra is None:

0 commit comments

Comments
 (0)