Skip to content

Commit 186dbe9

Browse files
committed
irradiance.py: +units, +version_changed directive
1 parent a115f18 commit 186dbe9

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

pvlib/irradiance.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2181,6 +2181,9 @@ def dirindex(ghi, ghi_clearsky, dni_clear, zenith, times, pressure=101325.,
21812181
dni_clear : array-like
21822182
Direct normal irradiance from clear sky model. [Wm⁻²]
21832183
2184+
.. versionchanged:: 0.11.2
2185+
Renamed from ``dni_clearsky`` to ``dni_clear``.
2186+
21842187
zenith : array-like
21852188
True (not refraction-corrected) zenith angles in decimal
21862189
degrees. If Z is a vector it must be of the same size as all
@@ -3646,7 +3649,10 @@ def dni(ghi, dhi, zenith, dni_clear=None, clearsky_tolerance=1.1,
36463649
degrees. Angles must be >=0 and <=180.
36473650
36483651
dni_clear : Series, optional
3649-
Clearsky direct normal irradiance.
3652+
Clearsky direct normal irradiance. [Wm⁻²]
3653+
3654+
.. versionchanged:: 0.11.2
3655+
Renamed from ``clearsky_dni`` to ``dni_clear``.
36503656
36513657
clearsky_tolerance : float, default 1.1
36523658
If ``dni_clear`` is given this parameter can be used to allow a
@@ -3726,8 +3732,8 @@ def complete_irradiance(solar_zenith,
37263732
Pandas series of dni data, with datetime index. Must have the same
37273733
datetime index as ghi, dhi, and zenith series, when available.
37283734
dni_clear : Series, optional
3729-
Pandas series of clearsky dni data. Must have the same datetime index
3730-
as ghi, dhi, dni, and zenith series, when available. See
3735+
Pandas series of clearsky dni data [Wm⁻²]. Must have the same datetime
3736+
index as ghi, dhi, dni, and zenith series, when available. See
37313737
:py:func:`dni` for details.
37323738
37333739
Returns

0 commit comments

Comments
 (0)