grounddiffuse to get_ground_diffuse

Author: wholmgren

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

@@ -11,8 +11,10 @@ API Changes
 * Added irradiance.poa_components. Function is the same as the now-deprecated
   irradiance.globalinplane, but adds 'poa_sky_diffuse' and
   'poa_ground_diffuse' to the output. (:issue:`422`)
-* Deprecated irradiance.extraradiation. Use irradiance.extra_radiation instead.
-  irradiance.extraradiation will be removed in 0.5. (:issue:`422`)
+* Deprecated irradiance.extraradiation. Use irradiance.get_extra_radiation
+  instead. irradiance.extraradiation will be removed in 0.6. (:issue:`422`)
+* Deprecated irradiance.grounddiffuse. Use irradiance.get_ground_diffuse
+  instead. irradiance.grounddiffuse will be removed in 0.6. (:issue:`422`)
 
 Enhancements
 ~~~~~~~~~~~~

pvlib/irradiance.py

@@ -567,7 +567,7 @@ def globalinplane(aoi, dni, poa_sky_diffuse, poa_ground_diffuse):
     return irrads
 
 
-def grounddiffuse(surface_tilt, ghi, albedo=.25, surface_type=None):
+def get_ground_diffuse(surface_tilt, ghi, albedo=.25, surface_type=None):
     '''
     Estimate diffuse irradiance from ground reflections given
     irradiance, albedo, and surface tilt
@@ -634,6 +634,10 @@ def grounddiffuse(surface_tilt, ghi, albedo=.25, surface_type=None):
     return diffuse_irrad
 
 
+grounddiffuse = deprecated('0.5.2', alternative='get_ground_diffuse',
+                           name='grounddiffuse')(get_ground_diffuse)
+
+
 def isotropic(surface_tilt, dhi):
     r'''
     Determine diffuse irradiance from the sky on a tilted surface using