Skip to content

Commit 767a466

Browse files
authored
Merge pull request #2 from cwhanse/total_irrad-docstring
Fix formatting in irradiance.py
2 parents 5d5afde + beadc8d commit 767a466

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

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

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Bug fixes
1616
* fixed redeclaration of test_simplified_solis_series_elevation (:issue:`387`)
1717
* physicaliam now returns a Series if called with a Series as an
1818
argument. (:issue:`397`)
19+
* corrected docstring for irradiance.total_irrad (:issue: '423')
1920

2021
Documentation
2122
~~~~~~~~~~~~~

pvlib/irradiance.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ def total_irrad(surface_tilt, surface_azimuth,
341341
Returns
342342
-------
343343
total_irrad : OrderedDict or DataFrame
344-
Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse',
344+
Contains keys/columns ``'poa_global', 'poa_direct', 'poa_diffuse',
345345
'poa_sky_diffuse', 'poa_ground_diffuse'``.
346346
"""
347347

@@ -1333,8 +1333,8 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325.,
13331333
Determine DNI from GHI using the DIRINDEX model, which is a modification of
13341334
the DIRINT model with information from a clear sky model.
13351335
1336-
DIRINDEX [1] improves upon the DIRINT model by taking into account turbidity
1337-
when used with the Ineichen clear sky model results.
1336+
DIRINDEX [1] improves upon the DIRINT model by taking into account
1337+
turbidity when used with the Ineichen clear sky model results.
13381338
13391339
Parameters
13401340
----------
@@ -1396,7 +1396,8 @@ def dirindex(ghi, ghi_clearsky, dni_clearsky, zenith, times, pressure=101325.,
13961396
use_delta_kt_prime=use_delta_kt_prime,
13971397
temp_dew=temp_dew)
13981398

1399-
dni_dirint_clearsky = dirint(ghi_clearsky, zenith, times, pressure=pressure,
1399+
dni_dirint_clearsky = dirint(ghi_clearsky, zenith, times,
1400+
pressure=pressure,
14001401
use_delta_kt_prime=use_delta_kt_prime,
14011402
temp_dew=temp_dew)
14021403

0 commit comments

Comments
 (0)