docs: fix parameter name mismatches in docstrings (#2804)

* docs: fix parameter name mismatches in docstrings

- pvsystem.py: `aoi_model` -> `iam_model` in PVSystem.get_iam and
  Array.get_iam (signature parameter is `iam_model`)
- solarposition.py: `time` -> `times` in sun_rise_set_transit_ephem
- irradiance.py: _liujordan documented a nonexistent `pressure`
  parameter; replace with the actual `airmass` parameter
- bifacial/infinite_sheds.py: remove duplicated stale Parameters block
  in _poa_sky_diffuse_pv (listed `f_x` and `npoints` which are not
  parameters of this function)

* Add contributor entry to v0.15.3 whatsnew

* Update pvlib/irradiance.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

---------

Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>
Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

Author: 3 people

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

@@ -45,5 +45,6 @@ Maintenance
 
 Contributors
 ~~~~~~~~~~~~
+* Eesh Saxena (:ghuser:`eeshsaxena`)
 * Karl Hill (:ghuser:`karlhillx`)
 * Yonry Zhu (:ghuser:`yonryzhu`)

pvlib/bifacial/infinite_sheds.py

@@ -45,19 +45,6 @@ def _poa_sky_diffuse_pv(dhi, gcr, surface_tilt):
     Integrated view factors from the shaded and unshaded parts of
     the row slant height to the sky.
 
-    Parameters
-    ----------
-    f_x : numeric
-        Fraction of row slant height from the bottom that is shaded from
-        direct irradiance. [unitless]
-    surface_tilt : numeric
-        Surface tilt angle in degrees from horizontal, e.g., surface facing up
-        = 0, surface facing horizon = 90. [degree]
-    gcr : float
-        Ratio of row slant length to row spacing (pitch). [unitless]
-    npoints : int, default 100
-        Number of points for integration. [unitless]
-
     A detailed calculation would be
 
         dhi * (f_x * vf_shade_sky_integ + (1 - f_x) * vf_noshade_sky_integ)
@@ -73,9 +60,6 @@ def _poa_sky_diffuse_pv(dhi, gcr, surface_tilt):
 
     Parameters
     ----------
-    f_x : numeric
-        Fraction of row slant height from the bottom that is shaded from
-        direct irradiance. [unitless]
     dhi : numeric
         Diffuse horizontal irradiance (DHI). [W/m^2]
     gcr : float

pvlib/irradiance.py

@@ -3122,8 +3122,8 @@ def _liujordan(zenith, transmittance, airmass, dni_extra=1367.0):
     transmittance: float
         Atmospheric transmittance between 0 and 1.
 
-    pressure: float, default 101325.0
-        Air pressure
+    airmass: numeric
+        Optical air mass. [unitless]
 
     dni_extra: float, default 1367.0
         Direct irradiance incident at the top of the atmosphere.

pvlib/pvsystem.py

@@ -395,7 +395,7 @@ def get_iam(self, aoi, iam_model='physical'):
         aoi : numeric or tuple of numeric
             The angle of incidence in degrees.
 
-        aoi_model : string, default 'physical'
+        iam_model : string, default 'physical'
             The IAM model to be used. Valid strings are 'physical', 'ashrae',
             'martin_ruiz', 'sapm' and 'interp'.
         Returns
@@ -1188,7 +1188,7 @@ def get_iam(self, aoi, iam_model='physical'):
         aoi : numeric
             The angle of incidence in degrees.
 
-        aoi_model : string, default 'physical'
+        iam_model : string, default 'physical'
             The IAM model to be used. Valid strings are 'physical', 'ashrae',
             'martin_ruiz', 'sapm' and 'interp'.
 

pvlib/solarposition.py

@@ -516,7 +516,7 @@ def sun_rise_set_transit_ephem(times, latitude, longitude,
 
     Parameters
     ----------
-    time : pandas.DatetimeIndex
+    times : pandas.DatetimeIndex
         Must be localized
     latitude : float
         Latitude in degrees, positive north of equator, negative to south