format and docstring edits

Author: cwhanse

pvlib/pvsystem.py

@@ -312,7 +312,7 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
                        dni_extra=None, airmass=None, albedo=None,
                        model='haydavies', **kwargs):
         """
-        Uses the :py:func:`irradiance.get_total_irradiance` function to
+        Uses :py:func:`pvlib.irradiance.get_total_irradiance` to
         calculate the plane of array irradiance components on the tilted
         surfaces defined by each array's ``surface_tilt`` and
         ``surface_azimuth``.
@@ -339,19 +339,20 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
             Irradiance model.
 
         kwargs
-            Extra parameters passed to :func:`irradiance.get_total_irradiance`.
+            Extra parameters passed to
+            :py:func:`pvlib.irradiance.get_total_irradiance`.
 
         Notes
         -----
-        Each of `dni`, `ghi`, and `dni` parameters may be passed as a tuple
+        Each of ``dni``, ``ghi``, and ``dni`` may be passed as a tuple
         of Series to provide different irradiance for each array in the system.
         If passed as a tuple of Series the tuple length must be the same
         as the number of Arrays. If not passed as a tuple then the same values
         are used for each Array.
 
-        Some sky irradiance models require `dni_extra`. For these models,
-        if `dni_extra` is not provided and ``solar_zenith`` has a
-        ``DatetimeIndex``, then `dni_extra` is calculated.
+        Some sky irradiance models require ``dni_extra``. For these models,
+        if ``dni_extra`` is not provided and ``solar_zenith`` has a
+        ``DatetimeIndex``, then ``dni_extra`` is calculated.
         Otherwise, ``dni_extra=1367`` is assumed.
 
         Returns
@@ -362,7 +363,7 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
 
         See also
         --------
-        pvlib.irradiance.get_total_irradiance
+        :py:func:`pvlib.irradiance.get_total_irradiance`
         """
         dni = self._validate_per_array(dni, system_wide=True)
         ghi = self._validate_per_array(ghi, system_wide=True)
@@ -1082,7 +1083,7 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
         """
         Get plane of array irradiance components.
 
-        Uses the :py:func:`pvlib.irradiance.get_total_irradiance` function to
+        Uses :py:func:`pvlib.irradiance.get_total_irradiance` to
         calculate the plane of array irradiance components for a surface
         defined by ``self.surface_tilt`` and ``self.surface_azimuth``.
 
@@ -1119,9 +1120,9 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
 
         Notes
         -----
-        Some sky irradiance models require `dni_extra`. For these models,
-        if `dni_extra` is not provided and ``solar_zenith`` has a
-        ``DatetimeIndex``, then `dni_extra` is calculated.
+        Some sky irradiance models require ``dni_extra``. For these models,
+        if ``dni_extra`` is not provided and ``solar_zenith`` has a
+        ``DatetimeIndex``, then ``dni_extra`` is calculated.
         Otherwise, ``dni_extra=1367`` is assumed.
 
         See also
@@ -1132,8 +1133,8 @@ def get_irradiance(self, solar_zenith, solar_azimuth, dni, ghi, dhi,
             albedo = self.albedo
 
         # dni_extra is not needed for all models, but this is easier
-        if dni_extra is None and hasattr(solar_zenith, 'index') and \
-            isinstance(solar_zenith.index, pd.DatetimeIndex):
+        if (dni_extra is None and hasattr(solar_zenith, 'index') and
+            isinstance(solar_zenith.index, pd.DatetimeIndex)):
             dni_extra = irradiance.get_extra_radiation(solar_zenith.index)
         else:
             # use the solar constant

pvlib/tests/test_pvsystem.py

@@ -1896,7 +1896,7 @@ def test_PVSystem_get_irradiance_float():
     for k, v in irradiance.items():
         assert np.isclose(v, expected[k], rtol=1e-6)
 
-    
+
 def test_PVSystem_get_irradiance_albedo(solar_pos):
     system = pvsystem.PVSystem(surface_tilt=32, surface_azimuth=135)
     irrads = pd.DataFrame({'dni': [900, 0], 'ghi': [600, 0], 'dhi': [100, 0],