fix handful of documentation warnings (#819)

wholmgren · web-flow · commit 9c364d8d0015 · 2019-11-26T11:37:47.000-07:00
* fix handful of documentation warnings

* more fixes
diff --git a/docs/sphinx/source/introexamples.rst b/docs/sphinx/source/introexamples.rst
@@ -164,7 +164,7 @@ by examining the parameters defined for the module.
                         orientation_strategy='south_at_latitude_tilt')
         # model results (ac, dc) and intermediates (aoi, temps, etc.)
         # assigned as mc object attributes
-        mc.run_model(times=times, weather=weather)
+        mc.run_model(weather)
         annual_energy = mc.ac.sum()
         energies[name] = annual_energy
 
diff --git a/docs/sphinx/source/modelchain.rst b/docs/sphinx/source/modelchain.rst
@@ -81,7 +81,7 @@ Next, we run a model with some simple weather data.
                            columns=['ghi', 'dni', 'dhi', 'temp_air', 'wind_speed'],
                            index=[pd.Timestamp('20170401 1200', tz='US/Arizona')])
 
-    mc.run_model(times=weather.index, weather=weather);
+    mc.run_model(weather);
 
 ModelChain stores the modeling results on a series of attributes. A few
 examples are shown below.
@@ -157,7 +157,7 @@ model, AC model, AOI loss model, and spectral loss model.
 
 .. ipython:: python
 
-    mc.run_model(times=weather.index, weather=weather);
+    mc.run_model(weather);
     mc.ac
 
 Alternatively, we could have specified single diode or PVWatts related
@@ -180,7 +180,7 @@ information to determine which of those models to choose.
 
 .. ipython:: python
 
-    mc.run_model(times=weather.index, weather=weather);
+    mc.run_model(weather);
     mc.ac
 
 User-supplied keyword arguments override ModelChain’s inspection
@@ -198,7 +198,7 @@ functions for a PVSystem that contains SAPM-specific parameters.
 
 .. ipython:: python
 
-    mc.run_model(times=weather.index, weather=weather);
+    mc.run_model(weather);
     mc.ac
 
 Of course, these choices can also lead to failure when executing
@@ -461,5 +461,5 @@ The end result is that ModelChain.run_model works as expected!
 
 .. ipython:: python
 
-    mc.run_model(times=weather.index, weather=weather);
+    mc.run_model(weather);
     mc.dc
diff --git a/docs/sphinx/source/timetimezones.rst b/docs/sphinx/source/timetimezones.rst
@@ -328,7 +328,7 @@ below? The solar position calculator will assume UTC time.
 
 .. ipython:: python
 
-    index = pd.DatetimeIndex(start='1997-01-01 01:00', freq='1h', periods=24)
+    index = pd.date_range(start='1997-01-01 01:00', freq='1h', periods=24)
     index
 
     solar_position_notz = pvlib.solarposition.get_solarposition(index,
diff --git a/docs/sphinx/source/whatsnew/v0.7.0.rst b/docs/sphinx/source/whatsnew/v0.7.0.rst
@@ -71,24 +71,24 @@ API Changes with Deprecations
       - If `PVSystem.temperature_model_parameters` is not specified, `ModelChain`
         defaults to old behavior, using the SAPM temperature model with parameter
         set `open_rack_glass_glass`. This behavior is deprecated, and will be
-         removed in v0.8. In v0.8 `PVSystem.temperature_model_parameters` will
-          be required for `ModelChain`.
+        removed in v0.8. In v0.8 `PVSystem.temperature_model_parameters` will
+        be required for `ModelChain`.
       - Implemented `pvsyst` as an option for `ModelChain.temperature_model`.
       - `modelchain.basic_chain` has a new required argument
         `temperature_model_parameters`.
 
 * Changes related to IAM (AOI loss) functions (:issue:`680`):
    * Changes to functions
       - Moved functions from `pvsystem.py` to `iam.py`. `pvsystem` IAM
-       functions are deprecated and will be removed in v0.8.
+        functions are deprecated and will be removed in v0.8.
       - Functions are renamed to a consistent pattern:
          - `pvsystem.physicaliam` is `iam.physical`
          - `pvsystem.ashraeiam` is `iam.ashrae`
          - `pvsystem.sapm_aoi_loss` is `iam.sapm`
    * Changes to `PVSystem` class
       - IAM models are provided by `PVSystem.get_iam` with kwarg `iam_model`.
       - Methods `PVSystem.ashraeiam`, `PVSystem.physicaliam` and
-       `PVSystem.sapm_aoi_loss` are deprecated and will be removed in v0.8.
+        `PVSystem.sapm_aoi_loss` are deprecated and will be removed in v0.8.
 
 * Changes related to spectral modifier (:issue:`782`):
    * Changes to functions
diff --git a/pvlib/bifacial.py b/pvlib/bifacial.py
@@ -18,7 +18,7 @@ def pvfactors_timeseries(
     """
     Calculate front and back surface plane-of-array irradiance on
     a fixed tilt or single-axis tracker PV array configuration, and using
-    the open-source "pvfactors" package.
+    the open-source "pvfactors" package [1]_.
     Please refer to pvfactors online documentation for more details:
     https://sunpower.github.io/pvfactors/
 
diff --git a/pvlib/iam.py b/pvlib/iam.py
@@ -398,12 +398,12 @@ def interp(aoi, theta_ref, iam_ref, method='linear', normalize=True):
 
     method : str, default 'linear'
         Specifies the interpolation method.
-        Useful options are: 'linear', 'quadratic','cubic'.
+        Useful options are: 'linear', 'quadratic', 'cubic'.
         See scipy.interpolate.interp1d for more options.
 
     normalize : boolean, default True
         When true, the interpolated values are divided by the interpolated
-        value at zero degrees.  This ensures that ``iam``=1.0 at normal
+        value at zero degrees.  This ensures that ``iam=1.0`` at normal
         incidence.
 
     Returns
diff --git a/pvlib/iotools/midc.py b/pvlib/iotools/midc.py
@@ -184,9 +184,7 @@ def read_midc(filename, variable_map={}, raw_data=False, **kwargs):
              passing the dictionary below will rename the column to 'ghi' in
              the returned Dataframe.
 
-             {
-                 'Global Horizontal [W/m^2]': ghi,
-             }
+             {'Global Horizontal [W/m^2]': 'ghi'}
 
     See the MIDC_VARIABLE_MAP for collection of mappings by site.
     For a full list of pvlib variable names see the `Variable Style Rules
diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py
@@ -1176,7 +1176,7 @@ def clearness_index(ghi, solar_zenith, extra_radiation, min_cos_zenith=0.065,
     Calculate the clearness index.
 
     The clearness index is the ratio of global to extraterrestrial
-    irradiance on a horizontal plane.
+    irradiance on a horizontal plane [1]_.
 
     Parameters
     ----------
@@ -1226,7 +1226,7 @@ def clearness_index(ghi, solar_zenith, extra_radiation, min_cos_zenith=0.065,
 def clearness_index_zenith_independent(clearness_index, airmass,
                                        max_clearness_index=2.0):
     """
-    Calculate the zenith angle independent clearness index.
+    Calculate the zenith angle independent clearness index [1]_.
 
     Parameters
     ----------
@@ -1764,7 +1764,8 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
                model='perez', model_perez='allsitescomposite1990',
                calculate_gt_90=True, max_iterations=30):
     """
-    Determine GHI, DNI, DHI from POA global using the GTI DIRINT model.
+    Determine GHI, DNI, DHI from POA global using the GTI DIRINT model
+    [1]_.
 
     .. warning::
 
