default None -> optional (#1574)

(?<spaces> {8}| {4})(?<name>\w*) : (?<types>.*), default None$
$1$2 : $3, optional

(?<spaces> {8}| {4})(?<name>\w*) : None or (?<type>.*), optional$
$1$2 : $3, optional

(?<spaces> {8}| {4})(?<name>\w*) : (?<type>.*) or [nN]one, optional$
$1$2 : $3, optional

Over files: pvlib/**/*.py

Author: echedey-ls

pvlib/clearsky.py

@@ -159,7 +159,7 @@ def lookup_linke_turbidity(time, latitude, longitude, filepath=None,
 
     longitude : float or int
 
-    filepath : None or string, default None
+    filepath : string, optional
         The path to the ``.h5`` file.
 
     interp_turbidity : bool, default True
@@ -703,7 +703,7 @@ def detect_clearsky(measured, clearsky, times=None, infer_limits=False,
         Time series of measured GHI. [W/m2]
     clearsky : array or Series
         Time series of the expected clearsky GHI. [W/m2]
-    times : DatetimeIndex or None, default None
+    times : DatetimeIndex, optional
         Times of measured and clearsky values. If None the index of measured
         will be used.
     infer_limits : bool, default False

pvlib/iam.py

@@ -514,7 +514,7 @@ def sapm(aoi, module, upper=None):
         A dict or Series with the SAPM IAM model parameters.
         See the :py:func:`sapm` notes section for more details.
 
-    upper : None or float, default None
+    upper : float, optional
         Upper limit on the results.
 
     Returns

pvlib/iotools/epw.py

@@ -25,7 +25,7 @@ def read_epw(filename, coerce_year=None):
     filename : String
         Can be a relative file path, absolute file path, or url.
 
-    coerce_year : None or int, default None
+    coerce_year : int, optional
         If supplied, the year of the data will be set to this value. This can
         be a useful feature because EPW data is composed of data from
         different years.
@@ -247,7 +247,7 @@ def parse_epw(csvdata, coerce_year=None):
     csvdata : file-like buffer
         a file-like buffer containing data in the EPW format
 
-    coerce_year : None or int, default None
+    coerce_year : int, optional
         If supplied, the year of the data will be set to this value. This can
         be a useful feature because EPW data is composed of data from
         different years.

pvlib/iotools/pvgis.py

@@ -63,13 +63,13 @@ def get_pvgis_hourly(latitude, longitude, start=None, end=None,
         In decimal degrees, between -90 and 90, north is positive (ISO 19115)
     longitude : float
         In decimal degrees, between -180 and 180, east is positive (ISO 19115)
-    start : int or datetime like, default None
+    start : int or datetime like, optional
         First year of the radiation time series. Defaults to first year
         available.
-    end : int or datetime like, default None
+    end : int or datetime like, optional
         Last year of the radiation time series. Defaults to last year
         available.
-    raddatabase : str, default None
+    raddatabase : str, optional
         Name of radiation database. Options depend on location, see [3]_.
     components : bool, default True
         Output solar radiation components (beam, diffuse, and reflected).
@@ -87,14 +87,14 @@ def get_pvgis_hourly(latitude, longitude, start=None, end=None,
            PVGIS website and pvlib<=0.9.5 is offset by 180 degrees.
     usehorizon : bool, default True
         Include effects of horizon
-    userhorizon : list of float, default None
+    userhorizon : list of float, optional
         Optional user specified elevation of horizon in degrees, at equally
         spaced azimuth clockwise from north, only valid if ``usehorizon`` is
         true, if ``usehorizon`` is true but ``userhorizon`` is ``None`` then
         PVGIS will calculate the horizon [4]_
     pvcalculation : bool, default False
         Return estimate of hourly PV production.
-    peakpower : float, default None
+    peakpower : float, optional
         Nominal power of PV system in kW. Required if pvcalculation=True.
     pvtechchoice : {'crystSi', 'CIS', 'CdTe', 'Unknown'}, default 'crystSi'
         PV technology.
@@ -309,7 +309,7 @@ def read_pvgis_hourly(filename, pvgis_format=None, map_variables=True):
     ----------
     filename : str, pathlib.Path, or file-like buffer
         Name, path, or buffer of hourly data file downloaded from PVGIS.
-    pvgis_format : str, default None
+    pvgis_format : str, optional
         Format of PVGIS file or buffer. Equivalent to the ``outputformat``
         parameter in the PVGIS API. If ``filename`` is a file and
         ``pvgis_format`` is ``None`` then the file extension will be used to
@@ -409,14 +409,14 @@ def get_pvgis_tmy(latitude, longitude, outputformat='json', usehorizon=True,
         documentation [2]_ for more info.
     usehorizon : bool, default True
         include effects of horizon
-    userhorizon : list of float, default None
+    userhorizon : list of float, optional
         optional user specified elevation of horizon in degrees, at equally
         spaced azimuth clockwise from north, only valid if ``usehorizon`` is
         true, if ``usehorizon`` is true but ``userhorizon`` is ``None`` then
         PVGIS will calculate the horizon [3]_
-    startyear : int, default None
+    startyear : int, optional
         first year to calculate TMY
-    endyear : int, default None
+    endyear : int, optional
         last year to calculate TMY, must be at least 10 years from first year
     url : str, default :const:`pvlib.iotools.pvgis.URL`
         base url of PVGIS API, append ``tmy`` to get TMY endpoint
@@ -573,7 +573,7 @@ def read_pvgis_tmy(filename, pvgis_format=None, map_variables=True):
     ----------
     filename : str, pathlib.Path, or file-like buffer
         Name, path, or buffer of file downloaded from PVGIS.
-    pvgis_format : str, default None
+    pvgis_format : str, optional
         Format of PVGIS file or buffer. Equivalent to the ``outputformat``
         parameter in the PVGIS TMY API. If ``filename`` is a file and
         ``pvgis_format`` is ``None`` then the file extension will be used to

pvlib/iotools/sodapro.py

@@ -87,7 +87,7 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear',
     integrated : boolean, default False
         Whether to return radiation parameters as integrated values (Wh/m^2)
         or as average irradiance values (W/m^2) (pvlib preferred units)
-    label : {'right', 'left'}, default None
+    label : {'right', 'left'}, optional
         Which bin edge label to label time-step with. The default is 'left' for
         all time steps except for '1M' which has a default of 'right'.
     map_variables : bool, default True
@@ -240,7 +240,7 @@ def parse_cams(fbuf, integrated=False, label=None, map_variables=True):
     integrated : boolean, default False
         Whether to return radiation parameters as integrated values (Wh/m^2)
         or as average irradiance values (W/m^2) (pvlib preferred units)
-    label : {'right', 'left'}, default None
+    label : {'right', 'left'}, optional
         Which bin edge label to label time-step with. The default is 'left' for
         all time steps except for '1M' which has a default of 'right'.
     map_variables : bool, default True
@@ -341,7 +341,7 @@ def read_cams(filename, integrated=False, label=None, map_variables=True):
     integrated : boolean, default False
         Whether to return radiation parameters as integrated values (Wh/m^2)
         or as average irradiance values (W/m^2) (pvlib preferred units)
-    label : {'right', 'left}, default None
+    label : {'right', 'left}, optional
         Which bin edge label to label time-step with. The default is 'left' for
         all time steps except for '1M' which has a default of 'right'.
     map_variables : bool, default True

pvlib/iotools/tmy.py

@@ -40,11 +40,11 @@ def read_tmy3(filename, coerce_year=None, map_variables=None, recolumn=None,
     ----------
     filename : str
         A relative file path or absolute file path.
-    coerce_year : None or int, default None
+    coerce_year : int, optional
         If supplied, the year of the index will be set to `coerce_year`, except
         for the last index value which will be set to the *next* year so that
         the index increases monotonically.
-    map_variables : bool, default None
+    map_variables : bool, optional
         When True, renames columns of the DataFrame to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
     recolumn : bool (deprecated, use map_variables instead)